Struct Adam 

pub struct Adam { /* private fields */ }

Adam optimiser state.

Keeps first- and second-moment vectors m and v for every parameter and applies bias correction using the timestep t.

Implementations

impl Adam

pub fn new(param_count: usize) -> Self

Create a new Adam optimiser for param_count parameters.

Defaults follow the original paper: lr = 0.001, beta1 = 0.9, beta2 = 0.999, eps = 1e-8.

pub fn with_lr(learning_rate: f32, param_count: usize) -> Self

Create an Adam optimiser with a custom learning rate.

pub fn with_hyperparams( learning_rate: f32, beta1: f32, beta2: f32, eps: f32, param_count: usize, ) -> Self

Create an Adam optimiser with full control over all hyperparameters.

pub fn param_count(&self) -> usize

Number of parameters tracked by this optimiser.

pub fn timestep(&self) -> u64

Current timestep.

pub fn step(&mut self, params: &mut [f32], grad: &[f32])

Perform one Adam update on params using the supplied gradient.

params and grad must have the same length as the optimiser’s parameter count.

pub fn step_clipped(&mut self, params: &mut [f32], grad: &[f32], max_norm: f32)

Perform one Adam update after clipping the gradient to max_norm.

If the global gradient norm is larger than max_norm, the whole gradient is rescaled before the Adam moment update. This matches the common “clip by global norm” behaviour.

pub fn step_slices(&mut self, params: &mut [&mut [f32]], grads: &[&[f32]])

Perform one Adam update on multiple parameter slices.

params and grads must have the same number of slices, and each corresponding slice must have the same length. This avoids flattening and reloading parameters when a model is stored in separate tensors.

pub fn step_slices_clipped( &mut self, params: &mut [&mut [f32]], grads: &[&[f32]], max_norm: f32, )

Perform one Adam update on multiple slices after global norm clipping.

pub fn reset(&mut self)

Reset all moment vectors to zero without changing hyperparameters.

Trait Implementations

impl Clone for Adam

fn clone(&self) -> Adam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Adam

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

Formats the value using the given formatter.