Skip to main content

LearningRateScheduler

Struct LearningRateScheduler 

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

Learning rate scheduler with warmup and cosine decay

Implementations§

Source§

impl LearningRateScheduler

Source

pub fn instance_of<V: NapiRaw>(env: Env, value: V) -> Result<bool>

Source§

impl LearningRateScheduler

Source§

impl LearningRateScheduler

Source

pub fn new(initial_lr: f64, warmup_steps: u32, total_steps: u32) -> Self

Create a new learning rate scheduler

§Arguments
  • initial_lr - Initial/peak learning rate
  • warmup_steps - Number of warmup steps
  • total_steps - Total training steps
Source

pub fn with_min_lr( initial_lr: f64, warmup_steps: u32, total_steps: u32, min_lr: f64, ) -> Self

Create with minimum learning rate

Source

pub fn get_lr(&self) -> f64

Get learning rate for current step

Source

pub fn step(&mut self) -> f64

Step the scheduler and return current learning rate

Source

pub fn reset(&mut self)

Reset scheduler to initial state

Source

pub fn current_step(&self) -> u32

Get current step

Source

pub fn progress(&self) -> f64

Get progress (0.0 to 1.0)

Trait Implementations§

Source§

impl FromNapiMutRef for LearningRateScheduler

Source§

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety Read more
Source§

impl FromNapiRef for LearningRateScheduler

Source§

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety Read more
Source§

impl FromNapiValue for &LearningRateScheduler

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl FromNapiValue for &mut LearningRateScheduler

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl ObjectFinalize for LearningRateScheduler

Source§

fn finalize(self, env: Env) -> Result<(), Error>

Source§

impl ToNapiValue for LearningRateScheduler

Source§

impl TypeName for &LearningRateScheduler

Source§

impl TypeName for &mut LearningRateScheduler

Source§

impl TypeName for LearningRateScheduler

Source§

impl ValidateNapiValue for &LearningRateScheduler

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more
Source§

impl ValidateNapiValue for &mut LearningRateScheduler

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety 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<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> JsValuesTupleIntoVec for T
where T: ToNapiValue,

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