Struct OneCycleLr 

pub struct OneCycleLr { /* private fields */ }

One-cycle learning-rate scheduler with linear warmup and linear cooldown.

Implementations

impl OneCycleLr

pub fn new(total_steps: usize, max_lr: f32) -> Result<Self, OptimError>

Creates one-cycle scheduler.

• total_steps > 0
• max_lr >= 0

pub fn with_pct_start(self, pct_start: f32) -> Result<Self, OptimError>

Sets fraction of cycle spent in the up phase.

pub fn with_final_div_factor( self, final_div_factor: f32, ) -> Result<Self, OptimError>

Sets divisor used for final LR (final_lr = initial_lr / final_div_factor).

pub fn with_initial_lr(self, initial_lr: f32) -> Result<Self, OptimError>

Pins explicit initial LR used by the schedule.

pub fn total_steps(&self) -> usize

pub fn max_lr(&self) -> f32

pub fn pct_start(&self) -> f32

pub fn final_div_factor(&self) -> f32

pub fn initial_lr(&self) -> Option<f32>

pub fn epoch(&self) -> usize

pub fn reset(&mut self)

pub fn step<O: LearningRate>( &mut self, optimizer: &mut O, ) -> Result<f32, OptimError>

Trait Implementations

impl Clone for OneCycleLr

fn clone(&self) -> OneCycleLr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OneCycleLr

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

Formats the value using the given formatter.

impl LrScheduler for OneCycleLr

fn step<O: LearningRate>( &mut self, optimizer: &mut O, ) -> Result<f32, OptimError>

Advances scheduler by one epoch and returns resulting optimizer LR.

fn epoch(&self) -> usize

Returns number of already-processed step calls.

fn reset(&mut self)

Resets scheduler internal state.

impl PartialEq for OneCycleLr

fn eq(&self, other: &OneCycleLr) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OneCycleLr