LARS

Struct LARS 

Source
pub struct LARS<A: Float> { /* private fields */ }
Expand description

Layer-wise Adaptive Rate Scaling (LARS) optimizer

LARS is an optimization algorithm specifically designed for large batch training, which allows scaling up the batch size significantly without loss of accuracy. It works by adapting the learning rate per layer based on the ratio of weight norm to gradient norm.

§Parameters

  • learning_rate - Base learning rate
  • momentum - Momentum factor (default: 0.9)
  • weight_decay - Weight decay factor (default: 0.0001)
  • trust_coefficient - Trust coefficient for scaling (default: 0.001)
  • eps - Small constant for numerical stability (default: 1e-8)
  • exclude_bias_and_norm - Whether to exclude bias and normalization layers from LARS adaptation (default: true)

§Example

use scirs2_core::ndarray::Array1;
use optirs_core::optimizers::{LARS, Optimizer};

let mut optimizer = LARS::new(0.01)
    .with_momentum(0.9)
    .with_weight_decay(0.0001)
    .with_trust_coefficient(0.001);

let params = Array1::zeros(10);
let gradients = Array1::ones(10);

let updated_params = optimizer.step(&params, &gradients).unwrap();
// Parameters are automatically updated

Implementations§

Source§

impl<A: Float + ScalarOperand + Debug + Send + Sync> LARS<A>

Source

pub fn new(learning_rate: A) -> Self

Create a new LARS optimizer with the given learning rate

Source

pub fn with_momentum(self, momentum: A) -> Self

Set the momentum factor

Source

pub fn with_weight_decay(self, weight_decay: A) -> Self

Set the weight decay factor

Source

pub fn with_trust_coefficient(self, trust_coefficient: A) -> Self

Set the trust coefficient

Source

pub fn with_eps(self, eps: A) -> Self

Set the epsilon value for numerical stability

Source

pub fn with_exclude_bias_and_norm(self, exclude_bias_and_norm: bool) -> Self

Set whether to exclude bias and normalization layers from LARS adaptation

Source

pub fn reset(&mut self)

Reset the optimizer state

Trait Implementations§

Source§

impl<A: Clone + Float> Clone for LARS<A>

Source§

fn clone(&self) -> LARS<A>

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<A: Debug + Float> Debug for LARS<A>

Source§

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

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

impl<A: Float + ScalarOperand + Debug + Send + Sync, D: Dimension + Send + Sync> Optimizer<A, D> for LARS<A>

Source§

fn step( &mut self, params: &Array<A, D>, gradients: &Array<A, D>, ) -> Result<Array<A, D>>

Updates parameters using the given gradients Read more
Source§

fn set_learning_rate(&mut self, learning_rate: A)

Sets a new learning rate
Source§

fn get_learning_rate(&self) -> A

Gets the current learning rate
Source§

fn step_list( &mut self, params_list: &[&Array<A, D>], gradients_list: &[&Array<A, D>], ) -> Result<Vec<Array<A, D>>>

Updates multiple parameter arrays at once Read more

Auto Trait Implementations§

§

impl<A> Freeze for LARS<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for LARS<A>
where A: RefUnwindSafe,

§

impl<A> Send for LARS<A>
where A: Send,

§

impl<A> Sync for LARS<A>
where A: Sync,

§

impl<A> Unpin for LARS<A>
where A: Unpin,

§

impl<A> UnwindSafe for LARS<A>
where A: UnwindSafe,

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

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

Source§

fn vzip(self) -> V