Struct CyclicLrScheduler 

pub struct CyclicLrScheduler {
    pub base_lr: f64,
    pub max_lr: f64,
    pub step_size: usize,
    pub mode: CyclicLrMode,
    pub gamma: f64,
    /* private fields */
}

Cyclic learning rate scheduler.

Fields

base_lr: f64

Base learning rate.

max_lr: f64

Maximum learning rate.

step_size: usize

Step size (half of cycle length).

mode: CyclicLrMode

Cyclic mode.

gamma: f64

Gamma for exponential range mode.

Implementations

impl CyclicLrScheduler

pub fn new( base_lr: f64, max_lr: f64, step_size: usize, mode: CyclicLrMode, ) -> Self

Create a new cyclic LR scheduler.

pub fn new_exp_range( base_lr: f64, max_lr: f64, step_size: usize, gamma: f64, ) -> Self

Create a new cyclic LR scheduler with exponential range mode.

Trait Implementations

impl Clone for CyclicLrScheduler

fn clone(&self) -> CyclicLrScheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CyclicLrScheduler

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

Formats the value using the given formatter.

impl LrScheduler for CyclicLrScheduler

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.