Struct burn::optim::AdamConfig

pub struct AdamConfig { /* private fields */ }

Adam configuration.

Implementations

impl AdamConfig

pub fn new() -> AdamConfig

Create a new instance of the config.

impl AdamConfig

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

Parameter for Adam.

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

Parameter for Adam.

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

A value required for numerical stability.

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

Set the default value for the field.

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

Set the default value for the field.

impl AdamConfig

pub fn init<B, M>( &self, ) -> OptimizerAdaptor<Adam<<B as AutodiffBackend>::InnerBackend>, M, B>

where B: AutodiffBackend, M: AutodiffModule<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) -> AdamConfig

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<'de> Deserialize<'de> for AdamConfig

fn deserialize<D>( deserializer: D, ) -> Result<AdamConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AdamConfig

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

Formats the value using the given formatter.

impl Serialize for AdamConfig

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

where S: Serializer,

Serialize this value into the given Serde serializer.