Skip to main content

LrScheduler

yscv_optim

Trait LrScheduler 

Source 
pub trait LrScheduler {
    // Required methods
    fn step<O: LearningRate>(
        &mut self,
        optimizer: &mut O,
    ) -> Result<f32, OptimError>;
    fn epoch(&self) -> usize;
    fn reset(&mut self);
}
Expand description

Scheduler abstraction for stateful learning-rate policies.

Required Methods§

Source

fn step<O: LearningRate>( &mut self, optimizer: &mut O, ) -> Result<f32, OptimError>

Advances scheduler by one epoch and returns resulting optimizer LR.

Source

fn epoch(&self) -> usize

Returns number of already-processed step calls.

Source

fn reset(&mut self)

Resets scheduler internal state.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§