Struct burn_core::optim::AdamConfig

pub struct AdamConfig { /* private fields */ }

Adam configuration.

Implementations

impl AdamConfig

pub fn new() -> Self

Create a new instance of the config.

impl AdamConfig

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

Parameter for Adam.

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

Parameter for Adam.

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

A value required for numerical stability.

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

Set the default value for the field.

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

Set the default value for the field.

impl AdamConfig

pub fn init<B: AutodiffBackend, M: AutodiffModule<B>>( &self ) -> impl Optimizer<M, B>

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 copy of the value.

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

Performs copy-assignment from source.

impl Config for AdamConfig

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

Saves the configuration to a file.

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

Loads the configuration from a file.

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

Loads the configuration from a binary buffer.

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.