Struct CosineAnnealingLrScheduler 

pub struct CosineAnnealingLrScheduler {
    pub initial_lr: f64,
    pub min_lr: f64,
    pub t_max: usize,
    /* private fields */
}

Cosine annealing learning rate scheduler. Anneals learning rate using a cosine schedule.

Fields

initial_lr: f64

Initial learning rate.

min_lr: f64

Minimum learning rate.

t_max: usize

Total number of epochs.

Implementations

impl CosineAnnealingLrScheduler

pub fn new(initial_lr: f64, min_lr: f64, t_max: usize) -> Self

Create a new cosine annealing LR scheduler.

Trait Implementations

impl Clone for CosineAnnealingLrScheduler

fn clone(&self) -> CosineAnnealingLrScheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CosineAnnealingLrScheduler

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

Formats the value using the given formatter.

impl LrScheduler for CosineAnnealingLrScheduler

fn step(&mut self, optimizer: &mut dyn Optimizer)

Update learning rate based on current step/epoch.

fn get_lr(&self) -> f64

Get current learning rate.

fn state_dict(&self) -> HashMap<String, f64>

Get scheduler state as a dictionary.

fn load_state_dict(&mut self, state: &HashMap<String, f64>) -> TrainResult<()>

Load scheduler state from a dictionary.