Adam

Struct Adam 

Source
pub struct Adam<B>
where B: Backend,
{ /* private fields */ }
Expand description

Adam optimizer (Adaptive Moment Estimation).

Standard defaults: lr=1e-3, β1=0.9, β2=0.999, ε=1e-8

Implementations§

Source§

impl<B> Adam<B>
where B: Backend,

Source

pub fn new(params: Vec<Tensor<B>>, lr: f64) -> Adam<B>

Create a standard Adam optimizer.

Source

pub fn beta1(self, beta1: f64) -> Adam<B>

Set β1 (1st moment decay rate).

Source

pub fn beta2(self, beta2: f64) -> Adam<B>

Set β2 (2nd moment decay rate).

Source

pub fn epsilon(self, eps: f64) -> Adam<B>

Set ε (numerical stability term).

Source

pub fn weight_decay(self, wd: f64) -> Adam<B>

Set weight decay (L2 penalty).

Source

pub fn params(&self) -> &[Tensor<B>]

Access current parameters.

Source

pub fn params_mut(&mut self) -> &mut Vec<Tensor<B>>

Mutable access to current parameters (for checkpoint loading).

Source

pub fn step_count(&self) -> u64

Get the step count.

Source

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

Set the learning rate (used by LR schedulers).

Trait Implementations§

Source§

impl<B> Optimizer<B> for Adam<B>
where B: Backend,

Source§

fn step(&mut self, grads: &GradStore<B>) -> Result<Vec<Tensor<B>>, Error>

Perform one optimization step. Read more
Source§

fn learning_rate(&self) -> f64

Return the current learning rate.
Source§

fn set_learning_rate(&mut self, lr: f64)

Set a new learning rate (for learning rate scheduling).
Source§

impl<B> Stateful for Adam<B>
where B: Backend,

Source§

fn state_dict(&self) -> OptimizerState

Export the optimizer’s internal state as a serializable dictionary.
Source§

fn load_state_dict(&mut self, state: &OptimizerState) -> Result<(), Error>

Restore the optimizer’s internal state from a previously saved dictionary. Read more

Auto Trait Implementations§

§

impl<B> Freeze for Adam<B>

§

impl<B> RefUnwindSafe for Adam<B>
where <B as Backend>::Device: RefUnwindSafe,

§

impl<B> Send for Adam<B>

§

impl<B> Sync for Adam<B>

§

impl<B> Unpin for Adam<B>

§

impl<B> UnwindSafe for Adam<B>
where <B as Backend>::Device: RefUnwindSafe,

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

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

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

§

fn vzip(self) -> V