Skip to content

Commit 63dd101

Browse files
add note about pecularitites issue 3088
1 parent d039089 commit 63dd101

9 files changed

+99
-6
lines changed

models/aeif_cond_alpha.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,15 @@ and
103103
For the reference implementation of this model, see
104104
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
105105
106-
See also [1]_.
106+
107+
.. note::
108+
109+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
110+
Brette & Gerstner [1]_.
111+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
112+
which can lead to exploding spike numbers and extreme slow-down of simulations.
113+
114+
We recommend users set ``t_ref > 0``.
107115
108116
Parameters
109117
++++++++++

models/aeif_cond_alpha_astro.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,15 @@ For implementation details of the adaptive exponential integrate-and-fire neuron
110110
model, see the
111111
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
112112
113-
See also [1]_.
113+
114+
.. note::
115+
116+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
117+
Brette & Gerstner [1]_.
118+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
119+
which can lead to exploding spike numbers and extreme slow-down of simulations.
120+
121+
We recommend users set ``t_ref > 0``.
114122
115123
Parameters
116124
++++++++++

models/aeif_cond_alpha_multisynapse.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,15 @@ When the neuron fires a spike, the adaptation current :math:`w <- w + b`.
9696
For implementation details see the
9797
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
9898
99+
.. note::
100+
101+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
102+
Brette & Gerstner [1]_.
103+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
104+
which can lead to exploding spike numbers and extreme slow-down of simulations.
105+
106+
We recommend users set ``t_ref > 0``.
107+
99108
Parameters
100109
++++++++++
101110
@@ -155,6 +164,14 @@ Receives
155164
156165
SpikeEvent, CurrentEvent, DataLoggingRequest
157166
167+
References
168+
++++++++++
169+
170+
.. [1] Brette R and Gerstner W (2005). Adaptive exponential
171+
integrate-and-fire model as an effective description of neuronal
172+
activity. Journal of Neurophysiology. 943637-3642
173+
DOI: https://doi.org/10.1152/jn.00686.2005
174+
158175
See also
159176
++++++++
160177

models/aeif_cond_beta_multisynapse.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,15 @@ When the neuron fires a spike, the adaptation current `w <- w + b`.
113113
For implementation details see the
114114
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
115115
116+
.. note::
117+
118+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
119+
Brette & Gerstner [1]_.
120+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
121+
which can lead to exploding spike numbers and extreme slow-down of simulations.
122+
123+
We recommend users set ``t_ref > 0``.
124+
116125
Parameters
117126
++++++++++
118127
@@ -172,6 +181,14 @@ Receives
172181
173182
SpikeEvent, CurrentEvent, DataLoggingRequest
174183
184+
References
185+
++++++++++
186+
187+
.. [1] Brette R and Gerstner W (2005). Adaptive exponential
188+
integrate-and-fire model as an effective description of neuronal
189+
activity. Journal of Neurophysiology. 943637-3642
190+
DOI: https://doi.org/10.1152/jn.00686.2005
191+
175192
See also
176193
++++++++
177194

models/aeif_cond_exp.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,15 @@ setting V_peak too high.
105105
For implementation details see the
106106
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
107107
108-
See also [1]_.
108+
109+
.. note::
110+
111+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
112+
Brette & Gerstner [1]_.
113+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
114+
which can lead to exploding spike numbers and extreme slow-down of simulations.
115+
116+
We recommend users set ``t_ref > 0``.
109117
110118
111119
Parameters:

models/aeif_psc_alpha.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,14 @@ Here :math:`H(t)` is the Heaviside step function and `k` indexes incoming spikes
9595
For implementation details see the
9696
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
9797
98-
See also [1]_.
98+
.. note::
99+
100+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
101+
Brette & Gerstner [1]_.
102+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
103+
which can lead to exploding spike numbers and extreme slow-down of simulations.
104+
105+
We recommend users set ``t_ref > 0``.
99106
100107
Parameters
101108
++++++++++

models/aeif_psc_delta.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,14 @@ the value of `J` after a spike.
9797
For implementation details see the
9898
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
9999
100-
See also [1]_.
100+
.. note::
101+
102+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
103+
Brette & Gerstner [1]_.
104+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
105+
which can lead to exploding spike numbers and extreme slow-down of simulations.
106+
107+
We recommend users set ``t_ref > 0``.
101108
102109
Parameters
103110
++++++++++

models/aeif_psc_delta_clopath.h

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,15 @@ For implementation details see the
9393
9494
See also [2]_.
9595
96+
.. note::
97+
98+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
99+
Brette & Gerstner [4]_.
100+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
101+
which can lead to exploding spike numbers and extreme slow-down of simulations.
102+
103+
We recommend users set ``t_ref > 0``.
104+
96105
Parameters
97106
++++++++++
98107
@@ -190,6 +199,11 @@ References
190199
.. [3] Voltage-based STDP synapse (Clopath et al. 2010) on ModelDB
191200
https://modeldb.science/144566?tab=1
192201
202+
.. [4] Brette R and Gerstner W (2005). Adaptive exponential
203+
integrate-and-fire model as an effective description of neuronal
204+
activity. Journal of Neurophysiology. 943637-3642
205+
DOI: https://doi.org/10.1152/jn.00686.2005
206+
193207
See also
194208
++++++++
195209

models/aeif_psc_exp.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,14 @@ Here :math:`H(t)` is the Heaviside step function and `k` indexes incoming spikes
9595
For implementation details see the
9696
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.
9797
98-
See also [1]_.
98+
.. note::
99+
100+
The default refractory period for ``aeif`` models is zero, consistent with the model definition in
101+
Brette & Gerstner [1]_.
102+
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
103+
which can lead to exploding spike numbers and extreme slow-down of simulations.
104+
105+
We recommend users set ``t_ref > 0``.
99106
100107
Parameters
101108
++++++++++

0 commit comments

Comments
 (0)