Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note to aeif models about refractory period and peculiarities #3296

Merged
merged 3 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion models/aeif_cond_alpha.h
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,15 @@ and
For the reference implementation of this model, see
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

See also [1]_.

.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.
heplesser marked this conversation as resolved.
Show resolved Hide resolved

We recommend users set ``t_ref > 0``.
heplesser marked this conversation as resolved.
Show resolved Hide resolved

Parameters
++++++++++
Expand Down
10 changes: 9 additions & 1 deletion models/aeif_cond_alpha_astro.h
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,15 @@ For implementation details of the adaptive exponential integrate-and-fire neuron
model, see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

See also [1]_.

.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++
Expand Down
17 changes: 17 additions & 0 deletions models/aeif_cond_alpha_multisynapse.h
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,15 @@ When the neuron fires a spike, the adaptation current :math:`w <- w + b`.
For implementation details see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++

Expand Down Expand Up @@ -155,6 +164,14 @@ Receives

SpikeEvent, CurrentEvent, DataLoggingRequest

References
++++++++++

.. [1] Brette R and Gerstner W (2005). Adaptive exponential
integrate-and-fire model as an effective description of neuronal
activity. Journal of Neurophysiology. 943637-3642
DOI: https://doi.org/10.1152/jn.00686.2005

See also
++++++++

Expand Down
17 changes: 17 additions & 0 deletions models/aeif_cond_beta_multisynapse.h
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,15 @@ When the neuron fires a spike, the adaptation current `w <- w + b`.
For implementation details see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++

Expand Down Expand Up @@ -172,6 +181,14 @@ Receives

SpikeEvent, CurrentEvent, DataLoggingRequest

References
++++++++++

.. [1] Brette R and Gerstner W (2005). Adaptive exponential
integrate-and-fire model as an effective description of neuronal
activity. Journal of Neurophysiology. 943637-3642
DOI: https://doi.org/10.1152/jn.00686.2005

See also
++++++++

Expand Down
10 changes: 9 additions & 1 deletion models/aeif_cond_exp.h
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,15 @@ setting V_peak too high.
For implementation details see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

See also [1]_.

.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.


Parameters:
Expand Down
9 changes: 8 additions & 1 deletion models/aeif_psc_alpha.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,14 @@ Here :math:`H(t)` is the Heaviside step function and `k` indexes incoming spikes
For implementation details see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

See also [1]_.
.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++
Expand Down
9 changes: 8 additions & 1 deletion models/aeif_psc_delta.h
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,14 @@ the value of `J` after a spike.
For implementation details see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

See also [1]_.
.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++
Expand Down
14 changes: 14 additions & 0 deletions models/aeif_psc_delta_clopath.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ For implementation details see the

See also [2]_.

.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [4]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++

Expand Down Expand Up @@ -190,6 +199,11 @@ References
.. [3] Voltage-based STDP synapse (Clopath et al. 2010) on ModelDB
https://modeldb.science/144566?tab=1

.. [4] Brette R and Gerstner W (2005). Adaptive exponential
integrate-and-fire model as an effective description of neuronal
activity. Journal of Neurophysiology. 943637-3642
DOI: https://doi.org/10.1152/jn.00686.2005

See also
++++++++

Expand Down
9 changes: 8 additions & 1 deletion models/aeif_psc_exp.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,14 @@ Here :math:`H(t)` is the Heaviside step function and `k` indexes incoming spikes
For implementation details see the
`aeif_models_implementation <../model_details/aeif_models_implementation.ipynb>`_ notebook.

See also [1]_.
.. note::

The default refractory period for ``aeif`` models is zero, consistent with the model definition in
Brette & Gerstner [1]_.
This means if the refractory period is zero, the ``aeif`` neurons can fire multiple spikes in a single time step,
which can lead to exploding spike numbers and extreme slow-down of simulations.

We recommend users set ``t_ref > 0``.

Parameters
++++++++++
Expand Down
Loading