RMSprop

Struct RMSprop 

Source
pub struct RMSprop { /* private fields */ }
Expand description

RMSprop optimizer.

Maintains a moving average of squared gradients to normalize updates.

Update rule:

v_t = alpha * v_{t-1} + (1 - alpha) * grad^2
param = param - lr * grad / (sqrt(v_t) + eps)

With momentum:

v_t = alpha * v_{t-1} + (1 - alpha) * grad^2
buf_t = momentum * buf_{t-1} + grad / (sqrt(v_t) + eps)
param = param - lr * buf_t

Implementations§

Source§

impl RMSprop

Source

pub fn new(params: Vec<Parameter>, lr: f32) -> Self

Creates a new RMSprop optimizer with default settings.

Source

pub fn with_alpha(params: Vec<Parameter>, lr: f32, alpha: f32) -> Self

Creates RMSprop with specified alpha (smoothing constant).

Source

pub fn with_options( params: Vec<Parameter>, lr: f32, alpha: f32, eps: f32, weight_decay: f32, momentum: f32, centered: bool, ) -> Self

Creates RMSprop with all options.

Source

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

Builder method to set alpha.

Source

pub fn eps(self, eps: f32) -> Self

Builder method to set epsilon.

Source

pub fn weight_decay(self, weight_decay: f32) -> Self

Builder method to set weight decay.

Source

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

Builder method to set momentum.

Source

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

Builder method to enable centered RMSprop.

Trait Implementations§

Source§

impl Optimizer for RMSprop

Source§

fn step(&mut self)

Performs a single optimization step. Read more
Source§

fn zero_grad(&mut self)

Zeros all parameter gradients.
Source§

fn get_lr(&self) -> f32

Returns the current learning rate.
Source§

fn set_lr(&mut self, lr: f32)

Sets the learning rate.
Source§

fn parameters(&self) -> &[Parameter]

Returns the parameters being optimized.
Source§

fn num_parameters(&self) -> usize

Returns the number of parameters.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V