Skip to main content

Lamb

Struct Lamb 

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

Layer-wise Adaptive Moments optimizer for Batch training (LAMB).

Combines Adam-style adaptive moment estimation with layer-wise trust ratio scaling for stable large-batch training.

Implementations§

Source§

impl Lamb

Source

pub fn new(lr: f32) -> Result<Self, OptimError>

Creates LAMB with required learning rate.

Source

pub fn with_betas(self, beta1: f32, beta2: f32) -> Result<Self, OptimError>

Sets beta coefficients (beta1, beta2) used for computing running averages.

Source

pub fn with_weight_decay(self, weight_decay: f32) -> Result<Self, OptimError>

Sets L2 weight decay factor in [0, +inf).

Source

pub fn with_epsilon(self, epsilon: f32) -> Result<Self, OptimError>

Sets epsilon value, must be finite and > 0.

Source

pub fn clear_state(&mut self)

Drops optimizer state (for example when restarting training).

Source

pub fn learning_rate(&self) -> f32

Returns current learning rate.

Source

pub fn set_learning_rate(&mut self, lr: f32) -> Result<(), OptimError>

Overrides current learning rate.

Source

pub fn step( &mut self, parameter_id: u64, weights: &mut Tensor, grad: &Tensor, ) -> Result<(), OptimError>

Applies one update to raw tensor weights.

Source

pub fn step_graph_node( &mut self, graph: &mut Graph, node: NodeId, ) -> Result<(), OptimError>

Applies one update to a trainable graph node by its NodeId.

Trait Implementations§

Source§

impl Clone for Lamb

Source§

fn clone(&self) -> Lamb

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
Source§

impl Debug for Lamb

Source§

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

Formats the value using the given formatter. Read more
Source§

impl LearningRate for Lamb

Source§

fn learning_rate(&self) -> f32

Returns current optimizer learning rate.
Source§

fn set_learning_rate(&mut self, lr: f32) -> Result<(), OptimError>

Sets optimizer learning rate after validation.
Source§

impl StepOptimizer for Lamb

Source§

fn step( &mut self, parameter_id: u64, weights: &mut Tensor, grad: &Tensor, ) -> Result<(), OptimError>

Auto Trait Implementations§

§

impl Freeze for Lamb

§

impl RefUnwindSafe for Lamb

§

impl Send for Lamb

§

impl Sync for Lamb

§

impl Unpin for Lamb

§

impl UnsafeUnpin for Lamb

§

impl UnwindSafe for Lamb

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> CloneToUninit for T
where T: Clone,

Source§

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
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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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.