Struct AdamConfig 

pub struct AdamConfig { /* private fields */ }

Adam configuration.

Implementations

impl AdamConfig

pub fn new() -> Self

Create a new instance of the config.

Arguments

Optional Arguments

weight_decay

Weight decay config.

• Defaults to None

grad_clipping

Gradient Clipping config.

• Defaults to None

Default Arguments

beta_1

Parameter for Adam.

• Defaults to 0.9

beta_2

Parameter for Adam.

• Defaults to 0.999

epsilon

A value required for numerical stability.

• Defaults to 1e-5

amsgrad

Whether to use AMSGrad algorithm

• Defaults to false

impl AdamConfig

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

Sets the value for the field beta_1.

Parameter for Adam.

• Defaults to 0.9

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

Sets the value for the field beta_2.

Parameter for Adam.

• Defaults to 0.999

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

Sets the value for the field epsilon.

A value required for numerical stability.

• Defaults to 1e-5

pub fn with_amsgrad(self, amsgrad: bool) -> Self

Sets the value for the field amsgrad.

Whether to use AMSGrad algorithm

• Defaults to false

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

Sets the value for the field weight_decay.

Weight decay config.

• Defaults to None

pub fn with_grad_clipping( self, grad_clipping: Option<GradientClippingConfig>, ) -> Self

Sets the value for the field grad_clipping.

Gradient Clipping config.

• Defaults to None

impl AdamConfig

pub fn build(&self) -> Adam

Build an Adam from the config.

The bare optimizer, which ModuleOptimizer::with_group takes to optimize one parameter group. init is the whole-module counterpart, and the only one that applies the configured gradient clipping.

pub fn init(&self) -> ModuleOptimizer

Initialize Adam optimizer.

Returns

Returns an optimizer that can be used to optimize a module.

Trait Implementations

impl Clone for AdamConfig

fn clone(&self) -> Self

Returns a duplicate 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>,

Available on crate feature std only.

Saves the configuration to a file.

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

where P: AsRef<Path>,

Available on crate feature std only.

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