Struct CosineAnnealingWarmRestarts 

pub struct CosineAnnealingWarmRestarts { /* private fields */ }

Cosine annealing with warm restarts learning-rate scheduler.

Within each period, LR follows cosine decay from base_lr to eta_min. After t_0 epochs, the schedule restarts and the next period length is t_0 * t_mult.

Formula within each period: lr = eta_min + 0.5 * (base_lr - eta_min) * (1 + cos(pi * t_cur / t_i))

Implementations

impl CosineAnnealingWarmRestarts

pub fn new(t_0: usize, t_mult: usize, eta_min: f32) -> Result<Self, OptimError>

Creates a cosine warm restarts scheduler.

• t_0 > 0: initial period length
• t_mult >= 1: period multiplier after each restart
• eta_min >= 0: minimum learning rate

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

Pins explicit base LR used by the schedule.

pub fn t_0(&self) -> usize

pub fn t_mult(&self) -> usize

pub fn eta_min(&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 CosineAnnealingWarmRestarts

fn clone(&self) -> CosineAnnealingWarmRestarts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CosineAnnealingWarmRestarts

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

Formats the value using the given formatter.

impl LrScheduler for CosineAnnealingWarmRestarts

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 CosineAnnealingWarmRestarts

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