Struct StepLR

Source

pub struct StepLR { /* private fields */ }

Expand description

Decays learning rate by gamma every step_size epochs.

lr = initial_lr * gamma^(epoch // step_size)

Implementations§

Source §

impl StepLR

Source

pub fn new<O: Optimizer>(optimizer: &O, step_size: usize, gamma: f32) -> Self

Creates a new StepLR scheduler.

Trait Implementations§

Source §

impl LRScheduler for StepLR

Source §

fn step<O: Optimizer>(&mut self, optimizer: &mut O)

Updates the learning rate.

Source §

fn get_last_lr(&self) -> f32

Returns the current learning rate.

Source §

fn get_step(&self) -> usize

Returns the current epoch/step count.

Auto Trait Implementations§

§

impl UnwindSafe for StepLR

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §