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

Update documentation for iaf_psc_exp #3084

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ackurth
Copy link
Contributor

@ackurth ackurth commented Feb 1, 2024

No description provided.

@jessica-mitchell jessica-mitchell added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Feb 1, 2024
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Feb 1, 2024
@jessica-mitchell jessica-mitchell added this to To do in Models via automation Feb 1, 2024
@heplesser heplesser changed the title Updat documentation for iaf_psc_exp Update documentation for iaf_psc_exp Feb 5, 2024
Documentation automation moved this from In progress to Review Mar 1, 2024
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ackurth This looks quite good already, but see my inline comments. I would also like to ask for a slight re-ordering of material that you have not touched:

  1. Move the last paragraph before the Parameters section ("For conversion ...") before the note on the time constants.
  2. Put the material on the two different ways in which the model can handle input into a note as well.

/* BeginUserDocs: neuron, integrate-and-fire, current-based

Short description
+++++++++++++++++

Leaky integrate-and-fire neuron model with exponential PSCs
Leaky integrate-and-fire neuron model with exponential shaped input currents.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Leaky integrate-and-fire neuron model with exponential shaped input currents.
Leaky integrate-and-fire neuron model with exponential-shaped input currents

* a hard threshold,
* a fixed refractory period,
* no adaptation mechanisms,
* exponential shaped synaptic input currents according to [1]_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* exponential shaped synaptic input currents according to [1]_
* exponential-shaped synaptic input currents according to [1]_.


.. math::

i_{\text{syn, X}}(t) = e^{-\frac{t}{\tau_{\text{syn, X}}}} \Theta(t)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would include the weight w here and in the following equations to ensure that units work out, in the same corresponding way as for iaf_psc_delta.

``tau_syn_ex`` 2 ms :math:`\tau_{\text{syn, ex}}` Rise time of the excitatory synaptic alpha function
``tau_syn_in`` 2 ms :math:`\tau_{\text{syn, in}}` Rise time of the inhibitory synaptic alpha function
``I_e`` 0 pA :math:`I_\text{e}` Constant input current
``V_min`` :math:`-\infty` mV :math:`V_{\text{min}}` Absolute lower value for the membrane potential
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit surprising, but iaf_psc_exp does not seem to have V_min. Adding it would be a different issue.

Suggested change
``V_min`` :math:`-\infty` mV :math:`V_{\text{min}}` Absolute lower value for the membrane potential

Comment on lines +121 to +123
By default, :math:`V_\text{m}` is not bounded from below. To limit
hyperpolarization to biophysically plausible values, set parameter
:math:`V_{\text{min}}` as lower bound of :math:`V_\text{m}`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iaf_psc_exp does not seem to have this ...

Suggested change
By default, :math:`V_\text{m}` is not bounded from below. To limit
hyperpolarization to biophysically plausible values, set parameter
:math:`V_{\text{min}}` as lower bound of :math:`V_\text{m}`.

Models automation moved this from To do to Review Mar 1, 2024
@jessica-mitchell
Copy link
Contributor

Here is link to output on Read the Docs: https://nest-simulator--3084.org.readthedocs.build/en/3084/models/iaf_psc_exp.html

@jessica-mitchell
Copy link
Contributor

@ackurth @heplesser After some discussion with David D. about models, we noticed that in the original model description, it mentions the stochastic use case - which does not appear to be in this version - is that correct?

Spiking in this model can be either deterministic (delta=0) or stochastic (delta > 0). In the stochastic case this model implements a type of spike response model with escape noise

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation
Projects
Documentation
  
Review
Models
  
Review
Development

Successfully merging this pull request may close these issues.

None yet

3 participants