Skip to main content

LearningRateScheduler

Struct LearningRateScheduler 

Source
pub struct LearningRateScheduler { /* private fields */ }
Expand description

A learning-rate scheduler that adjusts the rate based on drift state.

Space complexity: O(1).

§Examples

use rill_ml::drift::{DriftLevel, LearningRateScheduler};

let mut sched = LearningRateScheduler::new(0.01, 2.0, 5.0).unwrap();
assert!((sched.current_lr() - 0.01).abs() < 1e-12);

sched.on_drift_level(DriftLevel::Warning);
assert!((sched.current_lr() - 0.02).abs() < 1e-12);

sched.on_drift_level(DriftLevel::Drift);
assert!((sched.current_lr() - 0.05).abs() < 1e-12);

Implementations§

Source§

impl LearningRateScheduler

Source

pub fn new( base_lr: f64, warning_multiplier: f64, drift_multiplier: f64, ) -> Result<Self, RillError>

Create a new scheduler.

Returns an error if:

  • base_lr is not finite or not strictly positive.
  • warning_multiplier is not finite or less than 1.
  • drift_multiplier is not finite or less than warning_multiplier.
Source

pub const fn base_lr(&self) -> f64

The configured base learning rate.

Source

pub const fn warning_multiplier(&self) -> f64

The configured warning multiplier.

Source

pub const fn drift_multiplier(&self) -> f64

The configured drift multiplier.

Source

pub const fn current_state(&self) -> DriftLevel

The current drift state.

Source

pub fn on_drift_level(&mut self, level: DriftLevel)

Update the scheduler with the latest drift level from a detector.

Source

pub fn current_lr(&self) -> f64

The current learning rate, adjusted for the drift state.

Source

pub fn reset(&mut self)

Reset to the None drift state (use base_lr).

Trait Implementations§

Source§

impl Clone for LearningRateScheduler

Source§

fn clone(&self) -> LearningRateScheduler

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LearningRateScheduler

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LearningRateScheduler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V