torchrecurrent.coRNNCell

class torchrecurrent.coRNNCell(input_size, hidden_size, bias=True, dt=1.0, gamma=0.0, epsilon=0.0, kernel_init=<function xavier_uniform_>, recurrent_kernel_init=<function xavier_uniform_>, cell_kernel_init=<function xavier_uniform_>, bias_init=<function zeros_>, recurrent_bias_init=<function zeros_>, cell_bias_init=<function zeros_>, device=None, dtype=None)

A Coupled Oscillatory RNN (coRNN) cell.

Implements the dynamics from “Coupled Oscillatory Recurrent Neural Units for Long‐Term Memory” <https://arxiv.org/abs/2010.00951>_.

\[\begin{split}\begin{aligned} \mathbf{c}(t) &= \mathbf{c}(t-1) + \Delta t \,\tanh\Bigl( \mathbf{W}_{ih}\mathbf{x}(t) + \mathbf{b}_{ih} + \mathbf{W}_{hh}\mathbf{h}(t-1) + \mathbf{b}_{hh} + \mathbf{W}_{ch}\mathbf{c}(t-1) + \mathbf{b}_{ch} \Bigr) - \Delta t\,\gamma\,\mathbf{h}(t-1) - \Delta t\,\epsilon\,\mathbf{c}(t), \\ \mathbf{h}(t) &= \mathbf{h}(t-1) + \Delta t\,\mathbf{c}(t) \end{aligned}\end{split}\]

where \(\Delta t\) (dt) is the integration step size, \(\gamma\) is a damping coefficient on the hidden state, and \(\epsilon\) damps the cell state.

Parameters:

input_size (int) – Number of features in the input inp.
hidden_size (int) – Number of features in the states.
bias (bool) – If False, no bias terms are used. Default: True.
dt (float) – Integration step size Δt. Default: 1.0.
gamma (float) – Damping on hidden state term. Default: 0.0.
epsilon (float) – Damping on cell state term. Default: 0.0.
kernel_init (Callable) – Initializer for input‐to‐hidden weights (default: nn.init.xavier_uniform_).
recurrent_kernel_init (Callable) – Initializer for hidden‐to‐hidden weights (default: nn.init.xavier_uniform_).
cell_kernel_init (Callable) – Initializer for cell‐to‐hidden weights (default: nn.init.xavier_uniform_).
bias_init (Callable) – Initializer for input biases (default: nn.init.zeros_).
recurrent_bias_init (Callable) – Initializer for hidden biases (default: nn.init.zeros_).
cell_bias_init (Callable) – Initializer for cell biases (default: nn.init.zeros_).
device (torch.device, optional) – Device for parameters.
dtype (torch.dtype, optional) – Data type for parameters.

Inputs:

inp (Tensor): of shape (batch, input_size) or (input_size,).
state (Tuple[Tensor, Tensor], optional):
previous (h, c) where each is shape (batch, hidden_size) or (hidden_size,). If not provided, both default to zeros.

Outputs:

new_h (Tensor): next hidden state, same shape as h.
new_c (Tensor): next cell state, same shape as c.

weight_ih

Input‐to‐hidden weights, shape (hidden_size, input_size).

Type:: Tensor

weight_hh

Hidden‐to‐hidden weights, shape (hidden_size, hidden_size).

Type:: Tensor

weight_ch

Cell‐to‐hidden weights, shape (hidden_size, hidden_size).

Type:: Tensor

bias_ih

Input bias, shape (hidden_size,).

Type:: Tensor

bias_hh

Hidden bias, shape (hidden_size,).

Type:: Tensor

bias_ch

Cell bias, shape (hidden_size,).

Type:: Tensor

Note

The cell state and hidden state interact like a second‐order oscillator, allowing rich, stable dynamics over long time horizons.

Examples::

>>> cell = coRNNCell(10, 20, dt=0.5, gamma=0.1, epsilon=0.05)
>>> x = torch.randn(4, 10)        # batch=4
>>> h0 = torch.zeros(4, 20)
>>> c0 = torch.zeros(4, 20)
>>> h1, c1 = cell(x, (h0, c0))

__init__(input_size, hidden_size, bias=True, dt=1.0, gamma=0.0, epsilon=0.0, kernel_init=<function xavier_uniform_>, recurrent_kernel_init=<function xavier_uniform_>, cell_kernel_init=<function xavier_uniform_>, bias_init=<function zeros_>, recurrent_bias_init=<function zeros_>, cell_bias_init=<function zeros_>, device=None, dtype=None)

Initialize internal Module state, shared by both nn.Module and ScriptModule.

Parameters:

input_size (int)
hidden_size (int)
bias (bool)
dt (float)
gamma (float)
epsilon (float)
kernel_init (Callable)
recurrent_kernel_init (Callable)
cell_kernel_init (Callable)
bias_init (Callable)
recurrent_bias_init (Callable)
cell_bias_init (Callable)
device (device | None)
dtype (dtype | None)

Methods

`__init__`(input_size, hidden_size[, bias, ...])	Initialize internal Module state, shared by both nn.Module and ScriptModule.
`add_module`(name, module)	Add a child module to the current module.
`apply`(fn)	Apply `fn` recursively to every submodule (as returned by `.children()`) as well as self.
`bfloat16`()	Casts all floating point parameters and buffers to `bfloat16` datatype.
`buffers`([recurse])	Return an iterator over module buffers.
`children`()	Return an iterator over immediate children modules.
`compile`(args, *kwargs)	Compile this Module's forward using `torch.compile()`.
`cpu`()	Move all model parameters and buffers to the CPU.
`cuda`([device])	Move all model parameters and buffers to the GPU.
`double`()	Casts all floating point parameters and buffers to `double` datatype.
`eval`()	Set the module in evaluation mode.
`extra_repr`()	Return the extra representation of the module.
`float`()	Casts all floating point parameters and buffers to `float` datatype.
`forward`(inp[, state])	Run one step of the recurrent cell.
`get_buffer`(target)	Return the buffer given by `target` if it exists, otherwise throw an error.
`get_extra_state`()	Return any extra state to include in the module's state_dict.
`get_parameter`(target)	Return the parameter given by `target` if it exists, otherwise throw an error.
`get_submodule`(target)	Return the submodule given by `target` if it exists, otherwise throw an error.
`half`()	Casts all floating point parameters and buffers to `half` datatype.
`init_weights`()
`ipu`([device])	Move all model parameters and buffers to the IPU.
`load_state_dict`(state_dict[, strict, assign])	Copy parameters and buffers from `state_dict` into this module and its descendants.
`modules`()	Return an iterator over all modules in the network.
`mtia`([device])	Move all model parameters and buffers to the MTIA.
`named_buffers`([prefix, recurse, ...])	Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
`named_children`()	Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
`named_modules`([memo, prefix, remove_duplicate])	Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
`named_parameters`([prefix, recurse, ...])	Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
`parameters`([recurse])	Return an iterator over module parameters.
`register_backward_hook`(hook)	Register a backward hook on the module.
`register_buffer`(name, tensor[, persistent])	Add a buffer to the module.
`register_forward_hook`(hook, *[, prepend, ...])	Register a forward hook on the module.
`register_forward_pre_hook`(hook, *[, ...])	Register a forward pre-hook on the module.
`register_full_backward_hook`(hook[, prepend])	Register a backward hook on the module.
`register_full_backward_pre_hook`(hook[, prepend])	Register a backward pre-hook on the module.
`register_load_state_dict_post_hook`(hook)	Register a post-hook to be run after module's `load_state_dict()` is called.
`register_load_state_dict_pre_hook`(hook)	Register a pre-hook to be run before module's `load_state_dict()` is called.
`register_module`(name, module)	Alias for `add_module()`.
`register_parameter`(name, param)	Add a parameter to the module.
`register_state_dict_post_hook`(hook)	Register a post-hook for the `state_dict()` method.
`register_state_dict_pre_hook`(hook)	Register a pre-hook for the `state_dict()` method.
`requires_grad_`([requires_grad])	Change if autograd should record operations on parameters in this module.
`set_extra_state`(state)	Set extra state contained in the loaded state_dict.
`set_submodule`(target, module[, strict])	Set the submodule given by `target` if it exists, otherwise throw an error.
`share_memory`()	See `torch.Tensor.share_memory_()`.
`state_dict`(*args[, destination, prefix, ...])	Return a dictionary containing references to the whole state of the module.
`to`(args, *kwargs)	Move and/or cast the parameters and buffers.
`to_empty`(*, device[, recurse])	Move the parameters and buffers to the specified device without copying storage.
`train`([mode])	Set the module in training mode.
`type`(dst_type)	Casts all parameters and buffers to `dst_type`.
`uses_double_state`()	Return True if forward returns (h, c), else just h.
`xpu`([device])	Move all model parameters and buffers to the XPU.
`zero_grad`([set_to_none])	Reset gradients of all model parameters.

Attributes

`T_destination`
`call_super_init`
`dump_patches`
`weight_ih`
`weight_hh`
`weight_ch`
`bias_ih`
`bias_hh`
`bias_ch`
`training`