Lif#
- class brainpy.dyn.Lif(size, sharding=None, keep_size=False, mode=None, name=None, spk_fun=InvSquareGrad(alpha=100.0), spk_dtype=None, spk_reset='soft', detach_spk=False, method='exp_auto', init_var=True, scaling=None, V_rest=0.0, V_reset=-5.0, V_th=20.0, R=1.0, tau=10.0, V_initializer=ZeroInit, noise=None)[source]#
Leaky integrate-and-fire neuron model.
The formal equations of a LIF model [1] is given by:
\[\begin{split}\tau \frac{dV}{dt} = - (V(t) - V_{rest}) + RI(t) \\ \text{after} \quad V(t) \gt V_{th}, V(t) = V_{reset}\end{split}\]where \(V\) is the membrane potential, \(V_{rest}\) is the resting membrane potential, \(V_{reset}\) is the reset membrane potential, \(V_{th}\) is the spike threshold, \(\tau\) is the time constant, and \(I\) is the time-variant synaptic inputs.
Examples
There is an example usage:
import brainpy as bp lif = bp.dyn.Lif(1) # raise input current from 4 mA to 40 mA inputs = bp.inputs.ramp_input(4, 40, 700, 100, 600,) runner = bp.DSRunner(lif, monitors=['V']) runner.run(inputs=inputs) bp.visualize.line_plot(runner.mon['ts'], runner.mon['V'], show=True)
- Parameters:
V_rest (
Union[float,TypeVar(ArrayType,Array,Variable,TrainVar,Array,ndarray),Callable]) – Resting membrane potential.V_reset (
Union[float,TypeVar(ArrayType,Array,Variable,TrainVar,Array,ndarray),Callable]) – Reset potential after spike.V_th (
Union[float,TypeVar(ArrayType,Array,Variable,TrainVar,Array,ndarray),Callable]) – Threshold potential of spike.R (
Union[float,TypeVar(ArrayType,Array,Variable,TrainVar,Array,ndarray),Callable]) – Membrane resistance.tau (
Union[float,TypeVar(ArrayType,Array,Variable,TrainVar,Array,ndarray),Callable]) – Membrane time constant.V_initializer (
Union[Callable,TypeVar(ArrayType,Array,Variable,TrainVar,Array,ndarray)]) – The initializer of membrane potential.size (
TypeVar(Shape,int,Tuple[int,...])) – The neuronal population size.keep_size (
bool) – Keep the neuron group size.spk_fun (
Callable) – The spike activation function.detach_spk (
bool)method (
str) – The numerical integration method.spk_type – The spike data type.
spk_reset (
str) – The way to reset the membrane potential when the neuron generates spikes. This parameter only works when the computing mode isTrainingMode. It can besoftandhard. Default issoft.