Struct burn::optim::AdamWConfig

pub struct AdamWConfig { /* private fields */ }

AdamW configuration.

Implementations

impl AdamWConfig

pub fn new() -> AdamWConfig

Create a new instance of the config.

impl AdamWConfig

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

Parameter for AdamW.

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

Parameter for AdamW.

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

A value required for numerical stability.

pub fn with_weight_decay(self, weight_decay: f32) -> AdamWConfig

Weight decay config.

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

Set the default value for the field.

impl AdamWConfig

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

where B: AutodiffBackend, M: AutodiffModule<B>,

Initialize AdamW optimizer.

Returns

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

Trait Implementations

impl Clone for AdamWConfig

fn clone(&self) -> AdamWConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for AdamWConfig

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 AdamWConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AdamWConfig

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

Formats the value using the given formatter.

impl Serialize for AdamWConfig

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.