Adam

Struct Adam 

Source
pub struct Adam<T: Float> { /* private fields */ }
Expand description

Adaptive Moment Estimation (ADAM) optimizer.

§Formulas

  1. First Moment Estimate (m):
m_t = \beta_1 \cdot m_{t-1} + (1 - \beta_1) \cdot g_t
  1. Second Moment Estimate (v):
v_t = \beta_2 \cdot v_{t-1} + (1 - \beta_2) \cdot g_t^2
  1. Bias-Corrected Estimates:
\hat{m}_t = \frac{m_t}{1 - \beta_1^t}
\hat{v}_t = \frac{v_t}{1 - \beta_2^t}
  1. Parameter Update:
\theta_{t+1} = \theta_t - \frac{\alpha}{\sqrt{\hat{v}_t} + \epsilon} \cdot \hat{m}_t

where:

  • $ m_t $ is the first moment estimate (mean of gradients).
  • $ v_t $ is the second moment estimate (uncentered variance of gradients).
  • $ g_t $ is the gradient at time step $ t $.
  • $ \beta_1 $ and $ \beta_2 $ are the decay rates for the moment estimates.
  • $ \alpha $ is the learning rate.
  • $ \epsilon $ is a small constant to prevent division by zero.
  • $ \theta_t $ are the parameters being optimized.

Implementations§

Source§

impl<T: Float> Adam<T>

Source

pub fn new(learning_rate: T, architecture: &Vec<Box<dyn Function<T>>>) -> Self

Source

pub fn full_new( learning_rate: T, beta1: T, beta2: T, epsilon: T, architecture: &Vec<Box<dyn Function<T>>>, ) -> Self

Trait Implementations§

Source§

impl<T: Float> Optimizer<T> for Adam<T>

Source§

fn step(&mut self, id: usize, weights: &mut Matrix<T>, gradients: &Matrix<T>)

Source§

fn change_learning_rate(&mut self, new_learning_rate: T)

Auto Trait Implementations§

§

impl<T> Freeze for Adam<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Adam<T>
where T: RefUnwindSafe,

§

impl<T> Send for Adam<T>

§

impl<T> Sync for Adam<T>

§

impl<T> Unpin for Adam<T>
where T: Unpin,

§

impl<T> UnwindSafe for Adam<T>
where T: 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> 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, 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