Skip to main content

OptimizerState

rust_mlp::optim

Enum OptimizerState

pub enum OptimizerState {
    Sgd,
    SgdMomentum {
        momentum: f32,
        v_weights: Vec<Vec<f32>>,
        v_biases: Vec<Vec<f32>>,
    },
    Adam {
        beta1: f32,
        beta2: f32,
        eps: f32,
        t: u64,
        beta1_pow: f32,
        beta2_pow: f32,
        m_weights: Vec<Vec<f32>>,
        m_biases: Vec<Vec<f32>>,
        v_weights: Vec<Vec<f32>>,
        v_biases: Vec<Vec<f32>>,
    },
}

Expand description

Owned optimizer state.

Variants§

Sgd

Plain SGD (no state).

SgdMomentum

SGD with momentum state.

Fields

§momentum: f32

§v_weights: Vec<Vec<f32>>

§v_biases: Vec<Vec<f32>>

Adam

Adam state.

Fields

§beta1: f32

§beta2: f32

§eps: f32

§t: u64

§beta1_pow: f32

§beta2_pow: f32

§m_weights: Vec<Vec<f32>>

§m_biases: Vec<Vec<f32>>

§v_weights: Vec<Vec<f32>>

§v_biases: Vec<Vec<f32>>

Implementations§

impl OptimizerState

pub fn step(&mut self, model: &mut Mlp, grads: &mut Gradients, lr: f32)

Apply one optimizer step.

lr is passed in from the training loop to support learning rate schedules.

Trait Implementations§

impl Clone for OptimizerState

fn clone(&self) -> OptimizerState

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for OptimizerState

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

Formats the value using the given formatter. Read more

impl Default for OptimizerState

fn default() -> OptimizerState

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

Auto Trait Implementations§

impl Freeze for OptimizerState

impl RefUnwindSafe for OptimizerState

impl Send for OptimizerState

impl Sync for OptimizerState

impl Unpin for OptimizerState

impl UnwindSafe for OptimizerState

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V