Skip to main content

CosineAnnealingLR

mlx_optim

Struct CosineAnnealingLR 

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

Cosine annealing learning rate scheduler.

lr = eta_min + 0.5 * (base_lr - eta_min) * (1 + cos(pi * step / t_max))

Implementations§

Source§

impl CosineAnnealingLR

Source

pub fn new(base_lr: f32, t_max: u64, eta_min: f32) -> Self

Trait Implementations§

Source§

impl LrScheduler for CosineAnnealingLR

Source§

fn get_lr(&self, step: u64) -> f32

Return the learning rate for a given step.

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.