Struct RmsProp 

pub struct RmsProp { /* private fields */ }

RMSProp optimizer with optional momentum, weight decay, and centered variance.

Implementations

impl RmsProp

pub fn new(lr: f32) -> Result<Self, OptimError>

Creates RMSProp with required learning rate.

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

Sets RMSProp smoothing factor in [0, 1).

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

Sets epsilon value, must be finite and > 0.

pub fn with_weight_decay(self, weight_decay: f32) -> Result<Self, OptimError>

Sets L2 weight decay factor in [0, +inf).

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

Sets momentum factor in [0, 1).

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

Enables/disables centered RMSProp variant.

pub fn clear_state(&mut self)

Drops optimizer state (for example when restarting training).

pub fn learning_rate(&self) -> f32

Returns current learning rate.

pub fn set_learning_rate(&mut self, lr: f32) -> Result<(), OptimError>

Overrides current learning rate.

pub fn step( &mut self, parameter_id: u64, weights: &mut Tensor, grad: &Tensor, ) -> Result<(), OptimError>

Applies one update to raw tensor weights.

pub fn step_graph_node( &mut self, graph: &mut Graph, node: NodeId, ) -> Result<(), OptimError>

Applies one update to a trainable graph node by its NodeId.

Trait Implementations

impl Clone for RmsProp

fn clone(&self) -> RmsProp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RmsProp

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

Formats the value using the given formatter.

impl LearningRate for RmsProp

fn learning_rate(&self) -> f32

Returns current optimizer learning rate.

fn set_learning_rate(&mut self, lr: f32) -> Result<(), OptimError>

Sets optimizer learning rate after validation.

impl StepOptimizer for RmsProp

fn step( &mut self, parameter_id: u64, weights: &mut Tensor, grad: &Tensor, ) -> Result<(), OptimError>