Struct SgdConfig 

pub struct SgdConfig { /* private fields */ }

Configuration to create the Sgd optimizer.

Implementations

impl SgdConfig

pub fn new() -> SgdConfig

Create a new instance of the config.

Arguments

Optional Arguments

weight_decay

Weight decay config.

• Defaults to None

momentum

Momentum config.

• Defaults to None

gradient_clipping

Gradient Clipping config.

• Defaults to None

impl SgdConfig

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

Sets the value for the field weight_decay.

Weight decay config.

• Defaults to None

pub fn with_momentum(self, momentum: Option<MomentumConfig>) -> SgdConfig

Sets the value for the field momentum.

Momentum config.

• Defaults to None

pub fn with_gradient_clipping( self, gradient_clipping: Option<GradientClippingConfig>, ) -> SgdConfig

Sets the value for the field gradient_clipping.

Gradient Clipping config.

• Defaults to None

impl SgdConfig

pub fn build(&self) -> Sgd

Build a Sgd 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

Initializes the SGD optimizer from the configuration.

Trait Implementations

impl Clone for SgdConfig

fn clone(&self) -> SgdConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for SgdConfig

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 Debug for SgdConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SgdConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SgdConfig

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

Formats the value using the given formatter.

impl Serialize for SgdConfig

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.