Struct WarmupCosineLrScheduler 

pub struct WarmupCosineLrScheduler {
    pub target_lr: f64,
    pub min_lr: f64,
    pub warmup_steps: usize,
    pub total_steps: usize,
    /* private fields */
}

Warmup with cosine annealing scheduler.

Fields

target_lr: f64

Target learning rate after warmup.

min_lr: f64

Minimum learning rate.

warmup_steps: usize

Number of warmup steps.

total_steps: usize

Total number of steps (including warmup).

Implementations

impl WarmupCosineLrScheduler

pub fn new( target_lr: f64, min_lr: f64, warmup_steps: usize, total_steps: usize, ) -> Self

Create a new warmup cosine LR scheduler.

Trait Implementations

impl Clone for WarmupCosineLrScheduler

fn clone(&self) -> WarmupCosineLrScheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WarmupCosineLrScheduler

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

Formats the value using the given formatter.

impl LrScheduler for WarmupCosineLrScheduler

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.