Struct AdamParams 

pub struct AdamParams {
    pub learning_rate: f32,
    pub beta1: f32,
    pub beta2: f32,
    pub epsilon: f32,
    pub weight_decay: f32,
}

Hyper-parameters shared by GpuAdam and GpuAdamW.

Fields

learning_rate: f32

Step size.

beta1: f32

First-moment decay.

beta2: f32

Second-moment decay.

epsilon: f32

Denominator stabiliser.

weight_decay: f32

Weight decay (coupled L2 for Adam, decoupled for AdamW).

Implementations

impl AdamParams

pub fn new( learning_rate: f32, beta1: f32, beta2: f32, epsilon: f32, weight_decay: f32, ) -> Result<Self, GpuOptimError>

Build a validated parameter set.

Returns GpuOptimError::InvalidState instead of panicking when a value is outside its admissible range.

Trait Implementations

impl Clone for AdamParams

fn clone(&self) -> AdamParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AdamParams

impl Debug for AdamParams

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

Formats the value using the given formatter.

impl Default for AdamParams

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AdamParams

fn eq(&self, other: &AdamParams) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AdamParams