Struct OneCycleLrScheduler 

pub struct OneCycleLrScheduler {
    pub initial_lr: f64,
    pub max_lr: f64,
    pub min_lr: f64,
    pub total_steps: usize,
    pub pct_start: f64,
    /* private fields */
}

One-cycle learning rate scheduler. Increases LR from initial to max, then decreases to min.

Fields

initial_lr: f64

Initial learning rate.

max_lr: f64

Maximum learning rate.

min_lr: f64

Minimum learning rate (final).

total_steps: usize

Total number of steps.

pct_start: f64

Percentage of cycle spent increasing LR.

Implementations

impl OneCycleLrScheduler

pub fn new( initial_lr: f64, max_lr: f64, min_lr: f64, total_steps: usize, pct_start: f64, ) -> Self

Create a new one-cycle LR scheduler.

Trait Implementations

impl Clone for OneCycleLrScheduler

fn clone(&self) -> OneCycleLrScheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OneCycleLrScheduler

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

Formats the value using the given formatter.

impl LrScheduler for OneCycleLrScheduler

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.