Struct MetricLRScheduler 

pub struct MetricLRScheduler<F: Float + Debug + Display + FromPrimitive> { /* private fields */ }

A metric-based learning rate scheduler

Implementations

impl<F: Float + Debug + Display + FromPrimitive> MetricLRScheduler<F>

pub fn new<S: Into<String>>( initial_lr: F, factor: F, patience: usize, min_lr: F, metric_name: S, maximize: bool, ) -> Self

Create a new metric-based learning rate scheduler

pub fn set_threshold(&mut self, threshold: F) -> &mut Self

Set the threshold for measuring improvement

pub fn step_with_metric(&mut self, metric: F) -> F

Update the scheduler with a new metric value

pub fn get_learning_rate(&self) -> F

Get the current learning rate

pub fn reset(&mut self)

Reset the scheduler

pub fn history(&self) -> &[F]

Get the history of learning rates

pub fn metric_history(&self) -> &[F]

Get the history of metric values

pub fn best_metric(&self) -> Option<F>

Get the best metric value

pub fn to_scheduler_config(&self) -> SchedulerConfig<F>

Create a scheduler configuration for use with external optimizers

This returns the current state as a configuration that can be used to create or update external schedulers from scirs2-optim.

pub fn get_state(&self) -> SchedulerState<F>

Get the current scheduler state for external integration

Trait Implementations

impl<F: Clone + Float + Debug + Display + FromPrimitive> Clone for MetricLRScheduler<F>

fn clone(&self) -> MetricLRScheduler<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float + Debug + Display + FromPrimitive> Debug for MetricLRScheduler<F>

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

Formats the value using the given formatter.