Struct CosineAnnealingScheduler 

pub struct CosineAnnealingScheduler { /* private fields */ }

Cosine annealing with optional warm restarts (SGDR).

lr_t = min_lr + 0.5 * (max_lr - min_lr) * (1 + cos(pi * t_cur / t_max))

If restart_period is Some(T), restarts every T steps (warm restarts).

Implementations

impl CosineAnnealingScheduler

pub fn new( max_lr: f64, min_lr: f64, t_max: usize, ) -> Result<Self, SchedulerError>

Create a new cosine annealing scheduler.

Errors

Returns SchedulerError::InvalidConfig if any parameter is invalid.

pub fn with_warm_restarts(self, period: usize) -> Self

Enable warm restarts every period steps.

Trait Implementations

impl LrSchedulerV2 for CosineAnnealingScheduler

fn step(&mut self) -> f64

Advance one step and return the new learning rate.

fn current_lr(&self) -> f64

Return the current learning rate without advancing.

fn reset(&mut self)

Reset the scheduler to its initial state.

fn steps_taken(&self) -> usize

Total number of steps taken.

fn completed_cycle(&self) -> bool

Whether the scheduler has completed a cycle (if applicable).