RealmOA Library

oa::ml::nn::ResidualVectorQuantizer

Stack of independently EMA-trained residual vector quantizers.

StRust public API

Declaration

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

Public Methods

pub fn quantize(&self, latent: &Matrix) -> Result<ResidualVqResult>
pub fn ema_update(&self, result: &ResidualVqResult) -> Result<()>
pub fn lookup(&self, indices: &[Matrix]) -> Result<Matrix>
pub fn seed(&self, latents: &Matrix) -> Result<()>
pub fn num_levels(&self) -> usize
pub fn level(&self, index: usize) -> Option<&VectorQuantizer>
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, config: VectorQuantizerConfig, num_levels: usize, seed: u64, ) -> Result<Self>
pub fn new( engine: &Engine, config: VectorQuantizerConfig, num_levels: usize, ) -> Result<Self>

Public Method Documentation

pub fn quantize( &self, latent: &Matrix ) -> Result<ResidualVqResult>
No public source comment is attached to this declaration.
pub fn ema_update(&self, result: &ResidualVqResult) -> Result<()>
No public source comment is attached to this declaration.
pub fn lookup( &self, indices: &[Matrix] ) -> Result<Matrix>
No public source comment is attached to this declaration.
pub fn seed(&self, latents: &Matrix) -> Result<()>
No public source comment is attached to this declaration.
pub fn num_levels( &self ) -> usize
No public source comment is attached to this declaration.
pub fn level( &self, index: usize ) -> Option<&VectorQuantizer>
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, config: VectorQuantizerConfig, num_levels: usize, seed: u64 ) -> Result<Self>
No public source comment is attached to this declaration.
pub fn new( engine: &Engine, config: VectorQuantizerConfig, num_levels: usize ) -> Result<Self>
No public source comment is attached to this declaration.