oa::ml::Module

Stateful neural-network component with one registered ownership tree.

TrRust public API

Declaration

pub trait Module { Show 15 methods // Required methods fn forward(&self, input: &Matrix) -> Result<Matrix>; fn registry(&self) -> &ModuleRegistry; // Provided methods 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<'_> { ... } }
Public Rust declaration.

Public Methods

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<'_>

Public Method Documentation

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.