RealmOA Library

oa::ml::nn::FlowDenoiser

Trainable flow/diffusion denoiser with optional condition features and CFG.

StRust public API

Declaration

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

Public Methods

pub fn forward(&self, sample: &Matrix) -> Result<Matrix>
pub fn forward_conditioned( &self, sample: &Matrix, time: &Matrix, condition: Option<&Matrix>, token_mask: Option<&Matrix>, ) -> Result<Matrix>
pub fn forward_guided( &self, sample: &Matrix, time: &Matrix, condition: &Matrix, guidance_scale: f32, token_mask: Option<&Matrix>, ) -> Result<Matrix>
pub const fn config(&self) -> FlowDenoiserConfig
pub fn is_moe(&self) -> bool
pub fn backbone(&self) -> &FlowTransformer
pub fn position(&self) -> 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, config: FlowDenoiserConfig, seed: u64, ) -> Result<Self>

Public Method Documentation

pub fn forward( &self, sample: &Matrix ) -> Result<Matrix>
No public source comment is attached to this declaration.
pub fn forward_conditioned( &self, sample: &Matrix, time: &Matrix, condition: Option<&Matrix>, token_mask: Option<&Matrix> ) -> Result<Matrix>
No public source comment is attached to this declaration.
pub fn forward_guided( &self, sample: &Matrix, time: &Matrix, condition: &Matrix, guidance_scale: f32, token_mask: Option<&Matrix> ) -> Result<Matrix>
No public source comment is attached to this declaration.
pub const fn config( &self ) -> FlowDenoiserConfig
Construct a deterministic dense or MoE denoiser. Errors Returns an error for invalid model/time/dropout geometry or failed child, parameter, and buffer construction.
pub fn is_moe( &self ) -> bool
Construct a deterministic dense or MoE denoiser. Errors Returns an error for invalid model/time/dropout geometry or failed child, parameter, and buffer construction.
pub fn backbone( &self ) -> &FlowTransformer
Construct a deterministic dense or MoE denoiser. Errors Returns an error for invalid model/time/dropout geometry or failed child, parameter, and buffer construction.
pub fn position( &self ) -> Parameter
Construct a deterministic dense or MoE denoiser. Errors Returns an error for invalid model/time/dropout geometry or failed child, parameter, and buffer construction.
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: FlowDenoiserConfig, seed: u64 ) -> Result<Self>
No public source comment is attached to this declaration.