Struct PolynomialDecayLr 

pub struct PolynomialDecayLr { /* private fields */ }

Polynomial decay learning-rate scheduler.

Decays the learning rate from its initial value to end_lr over total_steps using a polynomial of the given power: lr = (base_lr - end_lr) * (1 - epoch/total_steps)^power + end_lr.

Implementations

impl PolynomialDecayLr

pub fn new( total_steps: usize, power: f32, end_lr: f32, ) -> Result<Self, OptimError>

Creates polynomial decay scheduler.

• total_steps > 0
• power > 0 and finite
• end_lr >= 0 and finite

pub fn with_base_lr(self, base_lr: f32) -> Result<Self, OptimError>

Pins explicit base LR used by the schedule.

pub fn total_steps(&self) -> usize

pub fn power(&self) -> f32

pub fn end_lr(&self) -> f32

pub fn base_lr(&self) -> Option<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 PolynomialDecayLr

fn clone(&self) -> PolynomialDecayLr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolynomialDecayLr

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

Formats the value using the given formatter.

impl LrScheduler for PolynomialDecayLr

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 PolynomialDecayLr

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