Skip to main content

MultiStepLR

Struct MultiStepLR 

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

Multi-step decay: multiply lr by gamma at each milestone.

lr = base_lr * gamma^(number_of_milestones_passed)

let sched = MultiStepLR::new(0.1, &[30, 60, 90], 0.1);
assert!((sched.lr(0) - 0.1).abs() < 1e-10);
assert!((sched.lr(30) - 0.01).abs() < 1e-10);
assert!((sched.lr(60) - 0.001).abs() < 1e-10);

Implementations§

Source§

impl MultiStepLR

Source

pub fn new(base_lr: f64, milestones: &[usize], gamma: f64) -> Self

Create a multi-step scheduler that decays lr by gamma at each milestone epoch. Milestones should be provided in ascending order.

Source

pub fn lr(&self, step: usize) -> f64

Learning rate at the given step.

Trait Implementations§

Source§

impl Scheduler for MultiStepLR

Source§

fn lr(&self, step: usize) -> f64

Learning rate at the given step (0-based).

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<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, 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.