Skip to main content

Adam

Struct Adam 

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

Pure-Rust PyTorch-compatible Adam optimizer (without decoupled weight decay) with state export/import.

Implementations§

Source§

impl Adam

Source

pub fn new( vars: &[(String, Var)], lr: f64, beta1: f64, beta2: f64, eps: f64, ) -> Result<Self, CodecError>

Creates an Adam optimizer tracking vars.

§Errors

Returns CodecError::Candle if moment buffer allocation fails.

Source

pub fn learning_rate(&self) -> f64

Returns the active learning rate.

Source

pub fn set_learning_rate(&mut self, lr: f64)

Updates the optimizer learning rate.

Source

pub fn step(&mut self, grads: &GradStore) -> Result<(), CodecError>

Performs one Adam update step over all tracked parameters present in grads.

§Errors

Returns CodecError::Candle if tensor updates fail.

Source

pub fn step_clipped( &mut self, grads: &GradStore, max_norm: f64, ) -> Result<f64, CodecError>

Computes global gradient L2 norm, applies global norm clipping up to max_norm (when max_norm > 0.0), and performs one fused Adam update step.

§Errors

Returns CodecError if gradient norm reduction or parameter updates fail.

Source

pub fn export_state( &self, prefix: &str, out_tensors: &mut HashMap<String, Tensor>, ) -> Result<BTreeMap<String, u64>, CodecError>

Exports moment tensors into out_tensors and returns per-parameter step counts for checkpointing.

§Errors

Returns CodecError::Candle if transferring moments to CPU fails.

Source

pub fn import_state( &mut self, prefix: &str, steps: &BTreeMap<String, u64>, tensors: &HashMap<String, Tensor>, ) -> Result<(), CodecError>

Restores step counts and moment buffers from a loaded checkpoint.

§Errors

Returns CodecError if any parameter state is missing or mismatched in shape.

Trait Implementations§

Source§

impl Debug for Adam

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Adam

§

impl !UnwindSafe for Adam

§

impl Freeze for Adam

§

impl Send for Adam

§

impl Sync for Adam

§

impl Unpin for Adam

§

impl UnsafeUnpin for Adam

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
§

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,

§

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

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more