Struct Lion

pub struct Lion { /* private fields */ }

Expand description

Lion (EvoLved Sign Momentum) optimizer.

Lion keeps a single momentum tensor and updates parameters with the sign of an interpolation between that momentum and the current gradient. Weight decay is decoupled from the gradient, as in AdamW.

Lion commonly needs a learning rate smaller than AdamW’s and a larger decoupled weight decay. These hyperparameters should be tuned together.

See Symbolic Discovery of Optimization Algorithms.

Trait Implementations§

§

impl Clone for Lion

§

fn clone(&self) -> Lion

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

§

impl Optimizer for Lion

§

type State<const D: usize> = LionState<D>

The state of the optimizer for a single parameter of rank D. Read more

§

fn step<const D: usize>( &self, lr: f64, tensor: Tensor<D>, grad: Tensor<D>, state: Option<<Lion as Optimizer>::State<D>>, ) -> (Tensor<D>, Option<<Lion as Optimizer>::State<D>>)

The optimizer step is performed for one tensor at a time with its gradient and state. Read more

§

fn to_device<const D: usize>( state: <Lion as Optimizer>::State<D>, device: &Device, ) -> <Lion as Optimizer>::State<D>

Change the device of the state. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Lion

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.

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

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

§

impl<K, Q> Comparable<Q> for K
where K: Borrow<Q> + ?Sized, Q: Ord + ?Sized,

§

fn compare(&self, key: &Q) -> Ordering

Compare self to key and return their ordering.

§

impl<O> DynOptimizer for O
where O: Optimizer,

§

fn step_dyn( &self, rank: usize, lr: f64, tensor: BridgeTensor, grad: BridgeTensor, state: Option<DynState>, ) -> (BridgeTensor, Option<DynState>)

Perform an optimizer step for a single parameter of the given rank.

§

fn to_device_dyn(&self, state: DynState, device: &Device) -> DynState

Move a state to the given device.

§

fn state_flatten(&self, prefix: &str, state: &DynState, out: &mut StateSink)

Decompose a state into named tensors and scalars under prefix.

§

fn state_unflatten( &self, rank: usize, prefix: &str, src: &mut StateSource, device: &Device, ) -> Option<DynState>

Rebuild a state of the given rank from named tensors and scalars under prefix. Read more

§

impl<K, Q> Equivalent<Q> for K
where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,

§

fn equivalent(&self, key: &Q) -> bool

Compare self to key and return true if they are equal.

§

impl<T> ErasedDestructor for T
where T: 'static,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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

§