Struct CosineAnnealingLr 

pub struct CosineAnnealingLr { /* private fields */ }

Cosine annealing learning-rate scheduler.

Computes: lr = min_lr + 0.5 * (base_lr - min_lr) * (1 + cos(pi * t_cur / t_max)), where t_cur is clamped to t_max.

Implementations

impl CosineAnnealingLr

pub fn new(t_max: usize, min_lr: f32) -> Result<Self, OptimError>

Creates cosine scheduler with t_max > 0 and finite min_lr >= 0.

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

Pins explicit base LR used by cosine schedule.

pub fn t_max(&self) -> usize

pub fn min_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 CosineAnnealingLr

fn clone(&self) -> CosineAnnealingLr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CosineAnnealingLr

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

Formats the value using the given formatter.

impl LrScheduler for CosineAnnealingLr

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 CosineAnnealingLr

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