Struct burn::optim::momentum::MomentumConfig

pub struct MomentumConfig {
    pub momentum: f64,
    pub dampening: f64,
    pub nesterov: bool,
}

Configuration to create momentum.

Fields

momentum: f64

Momemtum factor

dampening: f64

Dampening factor.

nesterov: bool

Enables Nesterov momentum, see On the importance of initialization and momentum in deep learning.

Implementations

impl MomentumConfig

pub fn new() -> MomentumConfig

Create a new instance of the config.

impl MomentumConfig

pub fn with_momentum(self, momentum: f64) -> MomentumConfig

Momemtum factor

pub fn with_dampening(self, dampening: f64) -> MomentumConfig

Dampening factor.

pub fn with_nesterov(self, nesterov: bool) -> MomentumConfig

Enables Nesterov momentum, see [On the importance of initialization and

Trait Implementations

impl Clone for MomentumConfig

fn clone(&self) -> MomentumConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for MomentumConfig

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 MomentumConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MomentumConfig

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

Formats the value using the given formatter.

impl Serialize for MomentumConfig

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.