brainpy.dyn.base.NeuGroup#

class brainpy.dyn.base.NeuGroup(size, keep_size=False, name=None, mode=NormalMode)[source]#

Base class to model neuronal groups.

There are several essential attributes:

  • size: the geometry of the neuron group. For example, (10, ) denotes a line of neurons, (10, 10) denotes a neuron group aligned in a 2D space, (10, 15, 4) denotes a 3-dimensional neuron group.

  • num: the flattened number of neurons in the group. For example, size=(10, ) => num=10, size=(10, 10) => num=100, size=(10, 15, 4) => num=600.

Parameters
  • size (int, tuple of int, list of int) – The neuron group geometry.

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

  • keep_size (bool) –

    Whether keep the geometry information.

    New in version 2.1.13.

  • mode (Mode) –

    New in version 2.2.0.

__init__(size, keep_size=False, name=None, mode=NormalMode)[source]#

Methods

__init__(size[, keep_size, name, mode])

clear_input()

Function to clear inputs in the neuron group.

get_batch_shape([batch_size])

get_delay_data(identifier, delay_step, *indices)

Get delay data according to the provided delay steps.

load_states(filename[, verbose])

Load the model states.

nodes([method, level, include_self])

Collect all children nodes.

offline_fit(target, fit_record)

offline_init()

online_fit(target, fit_record)

online_init()

register_delay(identifier, delay_step, ...)

Register delay variable.

register_implicit_nodes(*nodes, **named_nodes)

register_implicit_vars(*variables, ...)

reset([batch_size])

Reset function which reset the whole variables in the model.

reset_local_delays([nodes])

Reset local delay variables.

reset_state([batch_size])

Reset function which reset the states in the model.

save_states(filename[, variables])

Save the model states.

train_vars([method, level, include_self])

The shortcut for retrieving all trainable variables.

unique_name([name, type_])

Get the unique name for this object.

update(tdi[, x])

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

mode

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

name

Name of the model.

varshape

The shape of variables in the neuron group.