Struct AdamConfig

pub struct AdamConfig {
    pub beta_1: f64,
    pub beta_2: f64,
    pub epsilon: f64,
    pub weight_decay: Option<f64>,
}

Configuration for Adam optimizer.

Fields

beta_1: f64

The coefficient used for computing running average of gradient.

beta_2: f64

The coefficient used for computing running average of squared gradient.

epsilon: f64

A value added to the denominator to improve numerical stability.

weight_decay: Option<f64>

L2 penalty.

Implementations

impl AdamConfig

pub fn new() -> Self

Create a new instance of the config.

impl AdamConfig

pub fn with_beta_1(self, beta_1: f64) -> Self

The coefficient used for computing running average of gradient.

pub fn with_beta_2(self, beta_2: f64) -> Self

The coefficient used for computing running average of squared gradient.

pub fn with_epsilon(self, epsilon: f64) -> Self

A value added to the denominator to improve numerical stability.

pub fn with_weight_decay(self, weight_decay: Option<f64>) -> Self

Set the default value for the field.

impl AdamConfig

pub fn init<AB: AutodiffBackend, const D: usize>(self) -> Adam<AB, D>

Returns

An optimizer that can be used to optimize a value.

Trait Implementations

impl Clone for AdamConfig

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for AdamConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for AdamConfig

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

Formats the value using the given formatter.

impl Default for AdamConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AdamConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AdamConfig

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

Formats the value using the given formatter.

impl PartialEq for AdamConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AdamConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AdamConfig

impl StructuralPartialEq for AdamConfig