brainpy.dyn.neurons.OUProcess#

class brainpy.dyn.neurons.OUProcess(size, mean=0.0, sigma=1.0, tau=10.0, method='exp_euler', keep_size=False, mode=NormalMode, name=None)[source]#

The Ornstein–Uhlenbeck process.

The Ornstein–Uhlenbeck process \(x_{t}\) is defined by the following stochastic differential equation:

\[\tau dx_{t}=-\theta \,x_{t}\,dt+\sigma \,dW_{t}\]

where \(\theta >0\) and \(\sigma >0\) are parameters and \(W_{t}\) denotes the Wiener process.

Parameters
  • size (int, sequence of int) – The model size.

  • mean (Parameter) – The noise mean value.

  • sigma (Parameter) – The noise amplitude.

  • tau (Parameter) – The decay time constant.

  • method (str) – The numerical integration method for stochastic differential equation.

  • name (str) – The model name.

__init__(size, mean=0.0, sigma=1.0, tau=10.0, method='exp_euler', keep_size=False, mode=NormalMode, name=None)[source]#

Methods

__init__(size[, mean, sigma, tau, method, ...])

clear_input()

Function to clear inputs in the neuron group.

df(x, t)

dg(x, t)

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)

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.