Struct primitiv::optimizers::MomentumSGD

pub struct MomentumSGD { /* fields omitted */ }

Stochastic gradient descent with momentum.

Methods

impl MomentumSGD

pub fn new(eta: f32, momentum: f32) -> Self

Creates a new MomentumSGD object.

Trait Implementations

impl Debug for MomentumSGD

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Wrap<primitivOptimizer_t> for MomentumSGD

fn from_raw(ptr: *mut primitivOptimizer_t, _owned: bool) -> Self

fn as_ptr(&self) -> *const primitivOptimizer_t

fn as_mut_ptr(&mut self) -> *mut primitivOptimizer_t

fn is_owned(&self) -> bool

impl Drop for MomentumSGD

fn drop(&mut self)

Executes the destructor for this type.

impl Optimizer for MomentumSGD

fn load<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Loads configurations from a file.

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

Saves current configurations to a file.

fn get_epoch(&self) -> u32

Retrieves current epoch.

fn set_epoch(&mut self, epoch: u32)

Sets current epoch.

fn get_learning_rate_scaling(&self) -> f32

Retrieves current learning rate scaling factor.

fn set_learning_rate_scaling(&mut self, scale: f32)

Sets learning rate scaling factor.

fn get_weight_decay(&self) -> f32

Retrieves current L2 decay strength.

fn set_weight_decay(&mut self, strength: f32)

Sets L2 decay strength.

fn get_gradient_clipping(&self) -> f32

Retrieves current gradient clipping threshold.

fn set_gradient_clipping(&mut self, threshold: f32)

Sets gradient clipping threshold.

fn add_parameter(&mut self, param: &mut Parameter)

Registers a parameter.

fn add_parameters(&mut self, params: &mut [&mut Parameter])

Registers multiple parameters.

fn add_model<M: AsMut<Model>>(&mut self, model: &mut M)

Registers a model.

fn add_models<M: AsMut<Model>>(&mut self, models: &mut [&mut M])

Registers multiple models.

fn reset_gradients(&mut self)

Resets all gradients of registered parameters.

fn update(&mut self)

Updates parameter values.

fn get_uint_config(&self, key: &str) -> u32

Gets a configuration value.

fn set_uint_config(&mut self, key: &str, value: u32)

Sets a configuration value.

fn get_float_config(&self, key: &str) -> f32

Gets a configuration value.

fn set_float_config(&mut self, key: &str, value: f32)

Sets a configuration value.

impl Default for MomentumSGD

fn default() -> Self

Returns the "default value" for a type.