oa::ml::training::ReduceOnPlateauScheduler

Stateful schedule that lowers its rate after a monitored plateau.

StRust public API

Declaration

pub struct ReduceOnPlateauScheduler { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn step(&mut self, metric: f32) -> Result<()>
fn learning_rate(&self, _step: u64) -> f32

Associated Functions

pub fn with_defaults(initial_learning_rate: f32) -> Result<Self>
pub fn new( initial_learning_rate: f32, factor: f32, patience: u64, threshold: f32, min_learning_rate: f32, mode: PlateauMode, ) -> Result<Self>

Public Method Documentation

pub fn step(&mut self, metric: f32) -> Result<()>
No public source comment is attached to this declaration.
fn learning_rate( &self, _step: u64 ) -> f32
No public source comment is attached to this declaration.
pub fn with_defaults( initial_learning_rate: f32 ) -> Result<Self>
No public source comment is attached to this declaration.
pub fn new( initial_learning_rate: f32, factor: f32, patience: u64, threshold: f32, min_learning_rate: f32, mode: PlateauMode ) -> Result<Self>
No public source comment is attached to this declaration.