Struct CyclicLr 

pub struct CyclicLr { /* private fields */ }

Cyclic learning-rate scheduler with triangular policy.

Cycles the learning rate between base_lr and max_lr with a triangular waveform defined by step_size_up (ascending half) and step_size_down (descending half).

Implementations

impl CyclicLr

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

Creates cyclic LR scheduler.

• base_lr >= 0, max_lr >= base_lr
• step_size_up > 0, step_size_down > 0

pub fn base_lr(&self) -> f32

pub fn max_lr(&self) -> f32

pub fn step_size_up(&self) -> usize

pub fn step_size_down(&self) -> usize

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 CyclicLr

fn clone(&self) -> CyclicLr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CyclicLr

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

Formats the value using the given formatter.

impl LrScheduler for CyclicLr

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 CyclicLr

fn eq(&self, other: &CyclicLr) -> 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 CyclicLr