Label c_reg as "coefficient" instead of as "prefactor"

JesusEV · Sep 13, 2024 · d1744e0 · d1744e0
1 parent 6152cbb
commit d1744e0
Show file tree

Hide file tree

Showing 17 changed files with 22 additions and 22 deletions.
diff --git a/models/eprop_iaf.cpp b/models/eprop_iaf.cpp
@@ -170,7 +170,7 @@ eprop_iaf::Parameters_::set( const DictionaryDatum& d, Node* node )
 
   if ( c_reg_ < 0 )
   {
-    throw BadProperty( "Firing rate regularization prefactor c_reg ≥ 0 required." );
+    throw BadProperty( "Firing rate regularization coefficient c_reg ≥ 0 required." );
   }
 
   if ( f_target_ < 0 )

diff --git a/models/eprop_iaf.h b/models/eprop_iaf.h
@@ -234,7 +234,7 @@ V_th                        mV      :math:`v_\text{th}`                -55.0 Spi
 ----------------------------------------------------------------------------------------------------------------
 Parameter                   Unit Math equivalent             Default          Description
 =========================== ==== =========================== ================ ==================================
-c_reg                            :math:`c_\text{reg}`                     0.0 Prefactor of firing rate
+c_reg                            :math:`c_\text{reg}`                     0.0 Coefficient of firing rate
                                                                               regularization
 eprop_isi_trace_cutoff      ms   :math:`{\Delta t}_\text{c}` maximum value    Cutoff for integration of
                                                              representable    e-prop update between two
@@ -415,7 +415,7 @@ class eprop_iaf : public EpropArchivingNodeRecurrent
     //! Capacitance of the membrane (pF).
     double C_m_;
 
-    //! Prefactor of firing rate regularization.
+    //! Coefficient of firing rate regularization.
     double c_reg_;
 
     //! Leak / resting membrane potential (mV).

diff --git a/models/eprop_iaf_adapt.cpp b/models/eprop_iaf_adapt.cpp
@@ -190,7 +190,7 @@ eprop_iaf_adapt::Parameters_::set( const DictionaryDatum& d, Node* node )
 
   if ( c_reg_ < 0 )
   {
-    throw BadProperty( "Firing rate regularization prefactor c_reg ≥ 0 required." );
+    throw BadProperty( "Firing rate regularization coefficient c_reg ≥ 0 required." );
   }
 
   if ( f_target_ < 0 )

diff --git a/models/eprop_iaf_adapt.h b/models/eprop_iaf_adapt.h
@@ -217,7 +217,7 @@ V_th                        mV      :math:`v_\text{th}`                -55.0 Spi
 ----------------------------------------------------------------------------------------------------------------
 Parameter                   Unit    Math equivalent             Default          Description
 =========================== ======= =========================== ================ ===============================
-c_reg                               :math:`c_\text{reg}`                     0.0 Prefactor of firing rate
+c_reg                               :math:`c_\text{reg}`                     0.0 Coefficient of firing rate
                                                                                  regularization
 eprop_isi_trace_cutoff      ms      :math:`{\Delta t}_\text{c}` maximum value    Cutoff for integration of
                                                                 representable    e-prop update between two
@@ -389,7 +389,7 @@ class eprop_iaf_adapt : public EpropArchivingNodeRecurrent
     //! Capacitance of the membrane (pF).
     double C_m_;
 
-    //! Prefactor of firing rate regularization.
+    //! Coefficient of firing rate regularization.
     double c_reg_;
 
     //! Leak / resting membrane potential (mV).

diff --git a/models/eprop_iaf_adapt_bsshslm_2020.cpp b/models/eprop_iaf_adapt_bsshslm_2020.cpp
@@ -181,7 +181,7 @@ eprop_iaf_adapt_bsshslm_2020::Parameters_::set( const DictionaryDatum& d, Node*
 
   if ( c_reg_ < 0 )
   {
-    throw BadProperty( "Firing rate regularization prefactor c_reg ≥ 0 required." );
+    throw BadProperty( "Firing rate regularization coefficient c_reg ≥ 0 required." );
   }
 
   if ( f_target_ < 0 )

diff --git a/models/eprop_iaf_adapt_bsshslm_2020.h b/models/eprop_iaf_adapt_bsshslm_2020.h
@@ -196,7 +196,7 @@ V_th                        mV      :math:`v_\text{th}`                -55.0 Spi
 ----------------------------------------------------------------------------------------------------------------
 Parameter                   Unit    Math equivalent         Default          Description
 =========================== ======= ======================= ================ ===================================
-c_reg                               :math:`c_\text{reg}`                 0.0 Prefactor of firing rate
+c_reg                               :math:`c_\text{reg}`                 0.0 Coefficient of firing rate
                                                                              regularization
 f_target                    Hz      :math:`f^\text{target}`             10.0 Target firing rate of rate
                                                                              regularization
@@ -348,7 +348,7 @@ class eprop_iaf_adapt_bsshslm_2020 : public EpropArchivingNodeRecurrent
     //! Capacitance of the membrane (pF).
     double C_m_;
 
-    //! Prefactor of firing rate regularization.
+    //! Coefficient of firing rate regularization.
     double c_reg_;
 
     //! Leak / resting membrane potential (mV).

diff --git a/models/eprop_iaf_bsshslm_2020.cpp b/models/eprop_iaf_bsshslm_2020.cpp
@@ -161,7 +161,7 @@ eprop_iaf_bsshslm_2020::Parameters_::set( const DictionaryDatum& d, Node* node )
 
   if ( c_reg_ < 0 )
   {
-    throw BadProperty( "Firing rate regularization prefactor c_reg ≥ 0 required." );
+    throw BadProperty( "Firing rate regularization coefficient c_reg ≥ 0 required." );
   }
 
   if ( f_target_ < 0 )

diff --git a/models/eprop_iaf_bsshslm_2020.h b/models/eprop_iaf_bsshslm_2020.h
@@ -183,7 +183,7 @@ V_th                        mV      :math:`v_\text{th}`                -55.0 Spi
 ----------------------------------------------------------------------------------------------------------------
 Parameter                   Unit    Math equivalent         Default          Description
 =========================== ======= ======================= ================ ===================================
-c_reg                               :math:`c_\text{reg}`                 0.0 Prefactor of firing rate
+c_reg                               :math:`c_\text{reg}`                 0.0 Coefficient of firing rate
                                                                              regularization
 f_target                    Hz      :math:`f^\text{target}`             10.0 Target firing rate of rate
                                                                              regularization
@@ -327,7 +327,7 @@ class eprop_iaf_bsshslm_2020 : public EpropArchivingNodeRecurrent
     //! Capacitance of the membrane (pF).
     double C_m_;
 
-    //! Prefactor of firing rate regularization.
+    //! Coefficient of firing rate regularization.
     double c_reg_;
 
     //! Leak / resting membrane potential (mV).

diff --git a/models/eprop_iaf_psc_delta.cpp b/models/eprop_iaf_psc_delta.cpp
@@ -202,7 +202,7 @@ nest::eprop_iaf_psc_delta::Parameters_::set( const DictionaryDatum& d, Node* nod
   updateValueParam< bool >( d, names::refractory_input, with_refr_input_, node );
   if ( c_reg_ < 0 )
   {
-    throw BadProperty( "Firing rate regularization prefactor c_reg ≥ 0 required." );
+    throw BadProperty( "Firing rate regularization coefficient c_reg ≥ 0 required." );
   }
 
   if ( f_target_ < 0 )

diff --git a/models/eprop_iaf_psc_delta.h b/models/eprop_iaf_psc_delta.h
@@ -157,7 +157,7 @@ The following parameters can be set in the status dictionary.
 -------------------------------------------------------------------------------------------------------------------
 Parameter                   Unit    Math equivalent            Default          Description
 =========================== ======= ========================== ================ ===================================
-c_reg                               :math:`c_\text{reg}`                    0.0 Prefactor of firing rate
+c_reg                               :math:`c_\text{reg}`                    0.0 Coefficient of firing rate
                                                                                 regularization
 f_target                    Hz      :math:`f^\text{target}`                10.0 Target firing rate of rate
                                                                                 regularization
@@ -324,7 +324,7 @@ class eprop_iaf_psc_delta : public EpropArchivingNodeRecurrent
     bool with_refr_input_; //!< spikes arriving during refractory period are
                            //!< counted
 
-    //! Prefactor of firing rate regularization.
+    //! Coefficient of firing rate regularization.
     double c_reg_;
 
     //! Target firing rate of rate regularization (spikes/s).

diff --git a/pynest/examples/eprop_plasticity/eprop_supervised_classification_evidence-accumulation.py b/pynest/examples/eprop_plasticity/eprop_supervised_classification_evidence-accumulation.py
@@ -202,7 +202,7 @@
 params_nrn_reg = {
     "beta": 1.7,  # width scaling of the pseudo-derivative
     "C_m": 1.0,
-    "c_reg": 300.0 / duration["sequence"] * duration["learning_window"],  # firing rate regularization scaling
+    "c_reg": 300.0 / duration["sequence"] * duration["learning_window"],  # coefficient of firing rate regularization
     "E_L": 0.0,
     "eprop_isi_trace_cutoff": 100,
     "f_target": 10.0,  # spikes/s, target firing rate for firing rate regularization

diff --git a/...es/eprop_plasticity/eprop_supervised_classification_evidence-accumulation_bsshslm_2020.py b/...es/eprop_plasticity/eprop_supervised_classification_evidence-accumulation_bsshslm_2020.py
@@ -205,7 +205,7 @@
 params_nrn_reg = {
     "beta": 1.0,  # width scaling of the pseudo-derivative
     "C_m": 1.0,
-    "c_reg": 300.0,  # firing rate regularization scaling - 2*learning_window*(TF c_reg) for technical reasons
+    "c_reg": 300.0,  # coefficient of firing rate regularization - 2*learning_window*(TF c_reg) for technical reasons
     "E_L": 0.0,
     "f_target": 10.0,  # spikes/s, target firing rate for firing rate regularization
     "gamma": 0.3,  # height scaling of the pseudo-derivative

diff --git a/pynest/examples/eprop_plasticity/eprop_supervised_classification_neuromorphic_mnist.py b/pynest/examples/eprop_plasticity/eprop_supervised_classification_neuromorphic_mnist.py
@@ -197,7 +197,7 @@
 params_nrn_rec = {
     "beta": 1.7,  # width scaling of the pseudo-derivative
     "C_m": 1.0,
-    "c_reg": 2.0 / duration["sequence"],  # firing rate regularization scaling
+    "c_reg": 2.0 / duration["sequence"],  # coefficient of firing rate regularization
     "E_L": 0.0,
     "eprop_isi_trace_cutoff": 100,
     "f_target": 10.0,  # spikes/s, target firing rate for firing rate regularization

diff --git a/pynest/examples/eprop_plasticity/eprop_supervised_regression_handwriting_bsshslm_2020.py b/pynest/examples/eprop_plasticity/eprop_supervised_regression_handwriting_bsshslm_2020.py
@@ -196,7 +196,7 @@
     "beta": 1.0,  # width scaling of the pseudo-derivative
     "adapt_tau": 2000.0,  # ms, time constant of adaptive threshold
     "C_m": 250.0,
-    "c_reg": 150.0,  # firing rate regularization scaling
+    "c_reg": 150.0,  # coefficient of firing rate regularization
     "E_L": 0.0,
     "f_target": 20.0,  # spikes/s, target firing rate for firing rate regularization
     "gamma": 0.3,  # height scaling of the pseudo-derivative

diff --git a/pynest/examples/eprop_plasticity/eprop_supervised_regression_lemniscate_bsshslm_2020.py b/pynest/examples/eprop_plasticity/eprop_supervised_regression_lemniscate_bsshslm_2020.py
@@ -192,7 +192,7 @@
     "beta": 1.0,  # width scaling of the pseudo-derivative
     "adapt_tau": 2000.0,  # ms, time constant of adaptive threshold
     "C_m": 250.0,
-    "c_reg": 150.0,  # firing rate regularization scaling
+    "c_reg": 150.0,  # coefficient of firing rate regularization
     "E_L": 0.0,
     "f_target": 20.0,  # spikes/s, target firing rate for firing rate regularization
     "gamma": 0.3,  # height scaling of the pseudo-derivative

diff --git a/pynest/examples/eprop_plasticity/eprop_supervised_regression_sine-waves.py b/pynest/examples/eprop_plasticity/eprop_supervised_regression_sine-waves.py
@@ -187,7 +187,7 @@
 params_nrn_rec = {
     "beta": 33.3,  # width scaling of the pseudo-derivative
     "C_m": 1.0,
-    "c_reg": 300.0 / duration["sequence"],  # firing rate regularization scaling
+    "c_reg": 300.0 / duration["sequence"],  # coefficient of firing rate regularization
     "E_L": 0.0,
     "eprop_isi_trace_cutoff": 100,
     "f_target": 10.0,  # spikes/s, target firing rate for firing rate regularization

diff --git a/pynest/examples/eprop_plasticity/eprop_supervised_regression_sine-waves_bsshslm_2020.py b/pynest/examples/eprop_plasticity/eprop_supervised_regression_sine-waves_bsshslm_2020.py
@@ -185,7 +185,7 @@
 params_nrn_rec = {
     "beta": 1.0,  # width scaling of the pseudo-derivative
     "C_m": 1.0,
-    "c_reg": 300.0,  # firing rate regularization scaling
+    "c_reg": 300.0,  # coefficient of firing rate regularization
     "E_L": 0.0,
     "f_target": 10.0,  # spikes/s, target firing rate for firing rate regularization
     "gamma": 0.3,  # height scaling of the pseudo-derivative