Struct StepLr 

pub struct StepLr { /* private fields */ }

Piecewise constant learning-rate scheduler.

Every step_size calls to StepLr::step, the optimizer learning rate is multiplied by gamma.

Implementations

impl StepLr

pub fn new(step_size: usize, gamma: f32) -> Result<Self, OptimError>

Creates step scheduler with required step_size > 0 and gamma in (0, 1].

pub fn step_size(&self) -> usize

Returns configured step size.

pub fn gamma(&self) -> f32

Returns configured decay factor.

pub fn epoch(&self) -> usize

Returns number of already-processed step calls.

pub fn reset(&mut self)

Resets internal epoch counter.

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

Advances scheduler by one epoch and returns resulting optimizer LR.

Trait Implementations

impl Clone for StepLr

fn clone(&self) -> StepLr

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StepLr

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl LrScheduler for StepLr

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

Advances scheduler by one epoch and returns resulting optimizer LR.

fn epoch(&self) -> usize

Returns number of already-processed step calls.

fn reset(&mut self)

Resets scheduler internal state.

impl PartialEq for StepLr

fn eq(&self, other: &StepLr) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StepLr