brainpy.TwoEndConn#

class brainpy.TwoEndConn(pre, post, conn=None, output=NullSynOut, stp=None, ltp=None, mode=None, name=None)[source]#

Base class to model synaptic connections.

Parameters:

  • pre (NeuGroup) – Pre-synaptic neuron group.

  • post (NeuGroup) – Post-synaptic neuron group.

  • conn (optional, ndarray, ArrayType, dict, TwoEndConnector) – The connection method between pre- and post-synaptic groups.

  • output (Optional, SynOutput) –

    The output for the synaptic current.

    New in version 2.1.13: The output component for a two-end connection model.

  • stp (Optional, SynSTP) –

    The short-term plasticity model for the synaptic variables.

    New in version 2.1.13: The short-term plasticity component for a two-end connection model.

  • ltp (Optional, SynLTP) –

    The long-term plasticity model for the synaptic variables.

    New in version 2.1.13: The long-term plasticity component for a two-end connection model.

  • name (Optional, str) – The name of the dynamic system.

__init__(pre, post, conn=None, output=NullSynOut, stp=None, ltp=None, mode=None, name=None)[source]#

Methods

__init__(pre, post[, conn, output, stp, ...])

check_post_attrs(*attrs)

Check whether post group satisfies the requirement.

check_pre_attrs(*attrs)

Check whether pre group satisfies the requirement.

clear_input()

cpu()

Move all variable into the CPU device.

cuda()

Move all variables into the GPU device.

get_delay_data(identifier, delay_step, *indices)

Get delay data according to the provided delay steps.

load_state_dict(state_dict[, warn, compatible])

Copy parameters and buffers from state_dict into this module and its descendants.

load_states(filename[, verbose])

Load the model states.

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])

reset(*args, **kwargs)

Reset function which reset the whole variables in the model.

reset_local_delays([nodes])

Reset local delay variables.

reset_state(*args, **kwargs)

Reset function which reset the states in the model.

save_states(filename[, variables])

Save the model states.

state_dict()

Returns a dictionary containing a whole state of the module.

to(device)

Moves all variables into the given device.

tpu()

Move all variables into the TPU device.

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(*args, **kwargs)

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

global_delay_data

Global delay data, which stores the delay variables and corresponding delay targets.

mode

Mode of the model, which is useful to control the multiple behaviors of the model.

name

Name of the model.