brainpy.synapses.Delta#
- class brainpy.synapses.Delta(pre, post, conn, output=CUBA, stp=None, comp_method='sparse', g_max=1.0, delay_step=None, post_ref_key=None, name=None, mode=None, stop_spike_gradient=False)[source]#
Voltage Jump Synapse Model, or alias of Delta Synapse Model.
Model Descriptions
\[I_{syn} (t) = \sum_{j\in C} g_{\mathrm{max}} * \mathrm{STP} * \delta(t-t_j-D)\]where \(g_{\mathrm{max}}\) denotes the chemical synaptic strength, \(t_j\) the spiking moment of the presynaptic neuron \(j\), \(C\) the set of neurons connected to the post-synaptic neuron, \(D\) the transmission delay of chemical synapses, and \(\mathrm{STP}\) the short-term plasticity effect. For simplicity, the rise and decay phases of post-synaptic currents are omitted in this model.
Model Examples
>>> import brainpy as bp >>> from brainpy import synapses, neurons >>> import matplotlib.pyplot as plt >>> >>> neu1 = neurons.LIF(1) >>> neu2 = neurons.LIF(1) >>> syn1 = synapses.Alpha(neu1, neu2, bp.connect.All2All(), g_max=5.) >>> net = bp.Network(pre=neu1, syn=syn1, post=neu2) >>> >>> runner = bp.DSRunner(net, inputs=[('pre.input', 25.), ('post.input', 10.)], monitors=['pre.V', 'post.V', 'pre.spike']) >>> runner.run(150.) >>> >>> fig, gs = bp.visualize.get_figure(1, 1, 3, 8) >>> plt.plot(runner.mon.ts, runner.mon['pre.V'], label='pre-V') >>> plt.plot(runner.mon.ts, runner.mon['post.V'], label='post-V') >>> plt.xlim(40, 150) >>> plt.legend() >>> plt.show()
- Parameters:
pre (NeuDyn) – The pre-synaptic neuron group.
post (NeuDyn) – The post-synaptic neuron group.
conn (optional, ArrayType, dict of (str, ndarray), TwoEndConnector) – The synaptic connections.
comp_method (str) – The connection type used for model speed optimization. It can be sparse and dense. The default is sparse.
delay_step (int, ArrayType, Initializer, Callable) – The delay length. It should be the value of \(\mathrm{delay\_time / dt}\).
g_max (float, ArrayType, Initializer, Callable) – The synaptic strength. Default is 1.
post_ref_key (str) – Whether the post-synaptic group has refractory period.
- __init__(pre, post, conn, output=CUBA, stp=None, comp_method='sparse', g_max=1.0, delay_step=None, post_ref_key=None, name=None, mode=None, stop_spike_gradient=False)[source]#
Methods
__init__
(pre, post, conn[, output, stp, ...])add_aft_update
(key, fun)Add the after update into this node
add_bef_update
(key, fun)Add the before update into this node
add_inp_fun
(key, fun[, label, category])Add an input function.
check_post_attrs
(*attrs)Check whether post group satisfies the requirement.
check_pre_attrs
(*attrs)Check whether pre group satisfies the requirement.
clear_input
(*args, **kwargs)Empty function of clearing inputs.
cpu
()Move all variable into the CPU device.
cuda
()Move all variables into the GPU device.
get_aft_update
(key)Get the after update of this node by the given
key
.get_bef_update
(key)Get the before update of this node by the given
key
.get_delay_data
(identifier, delay_pos, *indices)Get delay data according to the provided delay steps.
get_delay_var
(name)get_inp_fun
(key)Get the input function.
get_local_delay
(var_name, delay_name)Get the delay at the given identifier (name).
has_aft_update
(key)Whether this node has the after update of the given
key
.has_bef_update
(key)Whether this node has the before update of the given
key
.jit_step_run
(i, *args, **kwargs)The jitted step function for running.
load_state
(state_dict, **kwargs)Load states from a dictionary.
load_state_dict
(state_dict[, warn, compatible])Copy parameters and buffers from
state_dict
into this module and its descendants.nodes
([method, level, include_self])Collect all children nodes.
register_delay
(identifier, delay_step, ...)Register delay variable.
register_implicit_nodes
(*nodes[, node_cls])register_implicit_vars
(*variables[, var_cls])register_local_delay
(var_name, delay_name[, ...])Register local relay at the given delay time.
reset
(*args, **kwargs)Reset function which reset the whole variables in the model (including its children models).
reset_local_delays
([nodes])Reset local delay variables.
reset_state
(*args, **kwargs)save_state
(**kwargs)Save states as a dictionary.
setattr
(key, value)- rtype:
state_dict
(**kwargs)Returns a dictionary containing a whole state of the module.
step_run
(i, *args, **kwargs)The step run function.
sum_current_inputs
(*args[, init, label])Summarize all current inputs by the defined input functions
.current_inputs
.sum_delta_inputs
(*args[, init, label])Summarize all delta inputs by the defined input functions
.delta_inputs
.sum_inputs
(*args, **kwargs)to
(device)Moves all variables into the given device.
tpu
()Move all variables into the TPU device.
tracing_variable
(name, init, shape[, ...])Initialize the variable which can be traced during computations and transformations.
train_vars
([method, level, include_self])The shortcut for retrieving all trainable variables.
tree_flatten
()Flattens the object as a PyTree.
tree_unflatten
(aux, dynamic_values)Unflatten the data to construct an object of this class.
unique_name
([name, type_])Get the unique name for this object.
update
([pre_spike])The function to specify the updating rule.
update_local_delays
([nodes])Update local delay variables.
vars
([method, level, include_self, ...])Collect all variables in this node and the children nodes.
Attributes
after_updates
before_updates
cur_inputs
current_inputs
delta_inputs
implicit_nodes
implicit_vars
mode
Mode of the model, which is useful to control the multiple behaviors of the model.
name
Name of the model.
supported_modes
Supported computing modes.