Struct burn_core::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() -> Self

Create a new instance of the config.

impl MomentumConfig

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

Momemtum factor

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

Dampening factor.

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

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

Trait Implementations

impl Clone for MomentumConfig

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 MomentumConfig

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 MomentumConfig

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

Deserialize this value from the given Serde deserializer.

impl Display for MomentumConfig

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

Formats the value using the given formatter.

impl Serialize for MomentumConfig

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

Serialize this value into the given Serde serializer.