brainpy.math.FunAsObject#

class brainpy.math.FunAsObject(target, child_objs=None, dyn_vars=None, name=None)[source]#

Transform a Python function as a BrainPyObject.

Parameters

  • target (callable) – The function to wrap.

  • child_objs (optional, BrainPyObject, sequence of BrainPyObject, dict) – The nodes in the defined function f.

  • dyn_vars (optional, Variable, sequence of Variable, dict) – The dynamically changed variables.

  • name (optional, str) – The function name.

__init__(target, child_objs=None, dyn_vars=None, name=None)[source]#

Methods

__init__(target[, child_objs, dyn_vars, name])

cpu()

Move all variable into the CPU device.

cuda()

Move all variables into the GPU device.

load_state_dict(state_dict[, warn])

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_implicit_nodes(*nodes[, node_cls])

register_implicit_vars(*variables, ...)

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)

New in version 2.3.1.

unique_name([name, type_])

Get the unique name for this object.

vars([method, level, include_self, ...])

Collect all variables in this node and the children nodes.

Attributes

name

Name of the model.