Struct burn_core::optim::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.

impl RMSPropConfig

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

Smoothing constant.

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

momentum for RMSProp.

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

A value required for numerical stability.

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

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

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

Set the default value for the field.

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

Set the default value for the field.

impl RMSPropConfig

pub fn init<B: AutodiffBackend, M: AutodiffModule<B>>( &self ) -> OptimizerAdaptor<RMSProp<B::InnerBackend>, M, B>

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 copy of the value.

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

Performs copy-assignment from source.

impl Config for RMSPropConfig

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 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.