RealmOA Library

oa::ml::nn::RnnCell

One Elman recurrent cell with an explicit caller-owned hidden state.

StRust public API

Declaration

pub struct RnnCell { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn zero_state(&self, batch: usize) -> Result<Matrix>
pub fn step(&self, input: &Matrix, hidden: &Matrix) -> Result<Matrix>
pub const fn input_size(&self) -> usize
pub const fn hidden_size(&self) -> usize
pub fn has_bias(&self) -> bool
pub fn all_parameters(&self) -> Result<Vec<Parameter>>
fn forward(&self, input: &Matrix) -> Result<Matrix>
fn registry(&self) -> &ModuleRegistry
fn parameters(&self) -> Vec<Parameter>
fn named_parameters(&self) -> Vec<NamedParameter>
fn buffers(&self) -> Vec<Matrix>
fn named_buffers(&self) -> Vec<NamedBuffer>
fn all_parameters(&self) -> Result<Vec<Parameter>>
fn all_named_parameters(&self) -> Result<Vec<NamedParameter>>
fn all_named_buffers(&self) -> Result<Vec<NamedBuffer>>
fn all_named_state_u32(&self) -> Result<Vec<NamedStateU32>>
fn num_parameters(&self) -> Result<usize>
fn train(&self, training: bool)
fn eval(&self)
fn is_training(&self) -> bool
fn scoped_eval(&self) -> ScopedEval<'_>

Associated Functions

pub fn with_seed( engine: &Engine, input_size: usize, hidden_size: usize, bias: bool, seed: u64, ) -> Result<Self>
pub fn from_matrices( weight_ih: Matrix, weight_hh: Matrix, bias_ih: Matrix, bias_hh: Matrix, ) -> Result<Self>
pub fn from_weights(weight_ih: Matrix, weight_hh: Matrix) -> Result<Self>

Public Method Documentation

pub fn zero_state( &self, batch: usize ) -> Result<Matrix>
No public source comment is attached to this declaration.
pub fn step( &self, input: &Matrix, hidden: &Matrix ) -> Result<Matrix>
No public source comment is attached to this declaration.
pub const fn input_size( &self ) -> usize
No public source comment is attached to this declaration.
pub const fn hidden_size( &self ) -> usize
No public source comment is attached to this declaration.
pub fn has_bias( &self ) -> bool
No public source comment is attached to this declaration.
pub fn all_parameters( &self ) -> Result<Vec<Parameter>>
No public source comment is attached to this declaration.
fn forward( &self, input: &Matrix ) -> Result<Matrix>
No public source comment is attached to this declaration.
fn registry( &self ) -> &ModuleRegistry
No public source comment is attached to this declaration.
fn parameters( &self ) -> Vec<Parameter>
No public source comment is attached to this declaration.
fn named_parameters( &self ) -> Vec<NamedParameter>
No public source comment is attached to this declaration.
fn buffers( &self ) -> Vec<Matrix>
No public source comment is attached to this declaration.
fn named_buffers( &self ) -> Vec<NamedBuffer>
No public source comment is attached to this declaration.
fn all_parameters( &self ) -> Result<Vec<Parameter>>
No public source comment is attached to this declaration.
fn all_named_parameters( &self ) -> Result<Vec<NamedParameter>>
No public source comment is attached to this declaration.
fn all_named_buffers( &self ) -> Result<Vec<NamedBuffer>>
No public source comment is attached to this declaration.
fn all_named_state_u32( &self ) -> Result<Vec<NamedStateU32>>
No public source comment is attached to this declaration.
fn num_parameters( &self ) -> Result<usize>
No public source comment is attached to this declaration.
fn train( &self, training: bool )
No public source comment is attached to this declaration.
fn eval( &self )
No public source comment is attached to this declaration.
fn is_training( &self ) -> bool
No public source comment is attached to this declaration.
fn scoped_eval( &self ) -> ScopedEval<'_>
No public source comment is attached to this declaration.
pub fn with_seed( engine: &Engine, input_size: usize, hidden_size: usize, bias: bool, seed: u64 ) -> Result<Self>
No public source comment is attached to this declaration.
pub fn from_matrices( weight_ih: Matrix, weight_hh: Matrix, bias_ih: Matrix, bias_hh: Matrix ) -> Result<Self>
No public source comment is attached to this declaration.
pub fn from_weights( weight_ih: Matrix, weight_hh: Matrix ) -> Result<Self>
No public source comment is attached to this declaration.