Struct LinearWarmupLr 

pub struct LinearWarmupLr { /* private fields */ }

Linear warmup learning-rate scheduler.

Computes: lr = start_lr + (base_lr - start_lr) * min(epoch, warmup_steps)/warmup_steps.

Implementations

impl LinearWarmupLr

pub fn new(warmup_steps: usize) -> Result<Self, OptimError>

Creates warmup scheduler with warmup_steps > 0.

pub fn with_start_lr(self, start_lr: f32) -> Result<Self, OptimError>

Sets explicit warmup start learning rate.

pub fn with_base_lr(self, base_lr: f32) -> Result<Self, OptimError>

Sets explicit warmup end/base learning rate.

pub fn warmup_steps(&self) -> usize

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

pub fn base_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 LinearWarmupLr

fn clone(&self) -> LinearWarmupLr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinearWarmupLr

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

Formats the value using the given formatter.

impl LrScheduler for LinearWarmupLr

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 LinearWarmupLr

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