Struct MultiStepLr 

pub struct MultiStepLr { /* private fields */ }

Multi-step learning-rate scheduler.

Drops the learning rate by gamma at each milestone epoch in milestones.

Implementations

impl MultiStepLr

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

Creates multi-step scheduler with sorted milestones and gamma in (0, 1].

pub fn milestones(&self) -> &[usize]

pub fn gamma(&self) -> f32

pub fn epoch(&self) -> usize

pub fn reset(&mut self)

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

Trait Implementations

impl Clone for MultiStepLr

fn clone(&self) -> MultiStepLr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiStepLr

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

Formats the value using the given formatter.

impl LrScheduler for MultiStepLr

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 MultiStepLr

fn eq(&self, other: &MultiStepLr) -> 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 MultiStepLr