Struct dfdx::optim::RMSprop

pub struct RMSprop<M, E: Dtype, D: Storage<E>> {
    pub cfg: RMSpropConfig,
    /* private fields */
}

RMSprop As described in Hinton, 2012.

This implementation is based off of RMSprop from pytorch-image-models because the pytorch implementation has some issues.

The main difference between the pytorch implementation is that RMSpropConfig::eps is added inside of the sqrt() operation.

The lr_in_momentum option is not provided because it didn’t seem to make a difference in testing.

Example Usage

Constructing using new:

let rmsprop: RMSprop<Model, f32, Cpu> = RMSprop::new(&model, RMSpropConfig {
    lr: 1e-3,
    alpha: 0.5,
    eps: 1e-8,
    momentum: Some(0.5),
    centered: false,
    weight_decay: Some(WeightDecay::Decoupled(1e-1)),
});

Fields

cfg: RMSpropConfig

Hyperparameter configuration

Implementations

impl<M, E: Dtype, D: Storage<E>> RMSprop<M, E, D>

pub fn new(_model: &M, cfg: RMSpropConfig) -> Self

Constructs using hyperparameters from cfg.

Trait Implementations

impl<M: Clone, E: Clone + Dtype, D: Clone + Storage<E>> Clone for RMSprop<M, E, D>

fn clone(&self) -> RMSprop<M, E, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug, E: Debug + Dtype, D: Debug + Storage<E>> Debug for RMSprop<M, E, D>

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

Formats the value using the given formatter.

impl<M: TensorCollection<E, D>, D: Device<E> + OneFillStorage<E>, E: Dtype> Optimizer<M, D, E> for RMSprop<M, E, D>

fn update( &mut self, module: &mut M, gradients: &Gradients<E, D> ) -> Result<(), OptimizerUpdateError<D::Err>>

Updates all of module’s parameters using gradients.