Struct StepDecayScheduler 

pub struct StepDecayScheduler { /* private fields */ }

Multiplies the learning rate by gamma every step_size steps.

lr_t = base_lr * gamma^floor(t / step_size)

Implementations

impl StepDecayScheduler

pub fn new( base_lr: f64, gamma: f64, step_size: usize, ) -> Result<Self, SchedulerError>

Create a new step decay scheduler.

Errors

Returns SchedulerError::InvalidConfig if any parameter is invalid.

Trait Implementations

impl LrSchedulerV2 for StepDecayScheduler

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).