Struct RmsPropConfig 

pub struct RmsPropConfig { /* private fields */ }

Configuration to create the RmsProp optimizer.

Implementations

impl RmsPropConfig

pub fn new() -> Self

Create a new instance of the config.

Arguments

Optional Arguments

weight_decay

Weight decay config.

• Defaults to None

grad_clipping

Gradient Clipping config.

• Defaults to None

Default Arguments

alpha

Smoothing constant.

• Defaults to 0.99

momentum

momentum for RmsProp.

• Defaults to 0.9

epsilon

A value required for numerical stability.

• Defaults to 1e-5

centered

if True, compute the centered RmsProp, the gradient is normalized by an estimation of its variance

• Defaults to false

impl RmsPropConfig

pub fn with_alpha(self, alpha: f32) -> Self

Sets the value for the field alpha.

Smoothing constant.

• Defaults to 0.99

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

Sets the value for the field momentum.

momentum for RmsProp.

• Defaults to 0.9

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

Sets the value for the field epsilon.

A value required for numerical stability.

• Defaults to 1e-5

pub fn with_centered(self, centered: bool) -> Self

Sets the value for the field centered.

if True, compute the centered RmsProp, the gradient is normalized by an estimation of its variance

• Defaults to false

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

Sets the value for the field weight_decay.

Weight decay config.

• Defaults to None

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

Sets the value for the field grad_clipping.

Gradient Clipping config.

• Defaults to None

impl RmsPropConfig

pub fn build(&self) -> RmsProp

Build a RmsProp from the config.

The bare optimizer, which ModuleOptimizer::with_group takes to optimize one parameter group. init is the whole-module counterpart, and the only one that applies the configured gradient clipping.

pub fn init(&self) -> ModuleOptimizer

Initialize RmsProp optimizer.

Returns

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

Trait Implementations

impl Clone for RmsPropConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for RmsPropConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Available on crate feature std only.

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Available on crate feature std only.

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for RmsPropConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RmsPropConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RmsPropConfig

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

Formats the value using the given formatter.

impl Serialize for RmsPropConfig

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

where S: Serializer,

Serialize this value into the given Serde serializer.