Struct ReduceLrOnPlateau 

pub struct ReduceLrOnPlateau { /* private fields */ }

Reduce learning rate when a metric has stopped improving.

When the metric has not improved for patience consecutive calls to ReduceLrOnPlateau::step_with_metric, the learning rate is multiplied by factor (clamped to min_lr).

Implementations

impl ReduceLrOnPlateau

pub fn new( factor: f32, patience: usize, min_lr: f32, ) -> Result<Self, OptimError>

Creates a plateau scheduler.

• factor in (0, 1]
• patience >= 1
• min_lr >= 0 and finite

pub fn factor(&self) -> f32

pub fn patience(&self) -> usize

pub fn min_lr(&self) -> f32

pub fn best_metric(&self) -> f32

pub fn wait(&self) -> usize

pub fn epoch(&self) -> usize

pub fn reset(&mut self)

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

Steps the scheduler with a metric value. If the metric has not improved for patience consecutive steps, the LR is reduced by factor. Lower metric is considered better.

Trait Implementations

impl Clone for ReduceLrOnPlateau

fn clone(&self) -> ReduceLrOnPlateau

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReduceLrOnPlateau

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

Formats the value using the given formatter.

impl LrScheduler for ReduceLrOnPlateau

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

Standard step without a metric does nothing to the LR (use step_with_metric instead).

fn epoch(&self) -> usize

Returns number of already-processed step calls.

fn reset(&mut self)

Resets scheduler internal state.

impl PartialEq for ReduceLrOnPlateau

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