braincore module#

The core system for the next-generation BrainPy framework.

State System#

State

The pointer to specify the dynamical data.

ShortTermState

The short-term state, which is used to store the short-term data in the program.

LongTermState

The long-term state, which is used to store the long-term data in the program.

ParamState

State Helpers#

check_state_value_tree

The contex manager to check weather the tree structure of the state value keeps consistently.

StateDictManager

State stack, for collecting all State used in the program.

visible_state_dict

The state dictionary whose elements are visible to .states() collection functions.

Module System#

Module

The Module class for the whole ecosystem.

ModuleGroup

A group of Module in which the updating order does not matter.

Sequential

A sequential input-output module.

Projection

Base class to model synaptic projections.

Dynamics

Dynamical System class.

Delay

Generate Delays for the given State instance.

DelayAccess

The delay access class.

Module Helpers#

visible_module_list

A sequence of Module, which is compatible with vars() and nodes() operations in a Module.

visible_module_dict

A dictionary of Module, which is compatible with vars() operation in a Module.

call_order

The decorator for indicating the resetting level.

init_states

Reset states of all children nodes in the given target.

load_states

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

save_states

Save all states in the target as a dictionary for later disk serialization.

Synaptic Projections#

HalfProjAlignPostMg

Defining the half part of synaptic projection with the align-post reduction and the automatic synapse merging.

FullProjAlignPostMg

Full-chain synaptic projection with the align-post reduction and the automatic synapse merging.

HalfProjAlignPost

Defining the half-part of synaptic projection with the align-post reduction.

FullProjAlignPost

Full-chain synaptic projection with the align-post reduction.

FullProjAlignPreSDMg

Full-chain synaptic projection with the align-pre reduction and synapse+delay updating and merging.

FullProjAlignPreDSMg

Full-chain synaptic projection with the align-pre reduction and delay+synapse updating and merging.

FullProjAlignPreSD

Full-chain synaptic projection with the align-pre reduction and synapse+delay updating.

FullProjAlignPreDS

Full-chain synaptic projection with the align-pre reduction and delay+synapse updating.

HalfProjDelta

Defining the half-part of the synaptic projection for the Delta synapse model.

FullProjDelta

Full-chain of the synaptic projection for the Delta synapse model.

VanillaProj

Synaptic projection which defines the synaptic computation with the dimension of pre-synaptic neuron group.