Trait OptimizerPlugin 

pub trait OptimizerPlugin<A: Float>:
    Debug
    + Send
    + Sync {
    // Required methods
    fn step(
        &mut self,
        params: &Array1<A>,
        gradients: &Array1<A>,
    ) -> Result<Array1<A>>;
    fn name(&self) -> &str;
    fn version(&self) -> &str;
    fn plugin_info(&self) -> PluginInfo;
    fn capabilities(&self) -> PluginCapabilities;
    fn initialize(&mut self, paramshape: &[usize]) -> Result<()>;
    fn reset(&mut self) -> Result<()>;
    fn get_config(&self) -> OptimizerConfig;
    fn set_config(&mut self, config: OptimizerConfig) -> Result<()>;
    fn get_state(&self) -> Result<OptimizerState>;
    fn set_state(&mut self, state: OptimizerState) -> Result<()>;
    fn clone_plugin(&self) -> Box<dyn OptimizerPlugin<A>>;

    // Provided methods
    fn memory_usage(&self) -> MemoryUsage { ... }
    fn performance_metrics(&self) -> PerformanceMetrics { ... }
}

Main trait for optimizer plugins

Required Methods

fn step( &mut self, params: &Array1<A>, gradients: &Array1<A>, ) -> Result<Array1<A>>

Perform a single optimization step

fn name(&self) -> &str

Get optimizer name

fn version(&self) -> &str

Get optimizer version

fn plugin_info(&self) -> PluginInfo

Get plugin information

fn capabilities(&self) -> PluginCapabilities

Get optimizer capabilities

fn initialize(&mut self, paramshape: &[usize]) -> Result<()>

Initialize optimizer with parameters

fn reset(&mut self) -> Result<()>

Reset optimizer state

fn get_config(&self) -> OptimizerConfig

Get optimizer configuration

fn set_config(&mut self, config: OptimizerConfig) -> Result<()>

Set optimizer configuration

fn get_state(&self) -> Result<OptimizerState>

Get optimizer state for serialization

fn set_state(&mut self, state: OptimizerState) -> Result<()>

Set optimizer state from deserialization

fn clone_plugin(&self) -> Box<dyn OptimizerPlugin<A>>

Clone the optimizer plugin

Provided Methods

fn memory_usage(&self) -> MemoryUsage

Get memory usage information

fn performance_metrics(&self) -> PerformanceMetrics

Get performance metrics

Implementors