RAdam

Struct RAdam 

Source
pub struct RAdam<A: Float + ScalarOperand + Debug> { /* private fields */ }
Expand description

RAdam (Rectified Adam) optimizer

Implements the RAdam algorithm from the paper: “On the Variance of the Adaptive Learning Rate and Beyond” by Liu et al. (2019).

RAdam improves upon Adam by addressing the early-stage training instability with a rectified variance term. It eliminates the need for a warmup period and often leads to better convergence.

Formula: m_t = beta1 * m_{t-1} + (1 - beta1) * g_t v_t = beta2 * v_{t-1} + (1 - beta2) * g_t^2 m_hat_t = m_t / (1 - beta1^t) v_hat_t = v_t / (1 - beta2^t)

If t > warmup_period (determined from beta2): r_t = sqrt((1 - beta2^t) / v_hat_t) * rect_term theta_t = theta_{t-1} - lr * m_hat_t * r_t Else: theta_t = theta_{t-1} - lr * m_hat_t (like plain SGD)

§Examples

use scirs2_core::ndarray::Array1;
use optirs_core::optimizers::{RAdam, Optimizer};

// Initialize parameters and gradients
let params = Array1::zeros(5);
let gradients = Array1::from_vec(vec![0.1, 0.2, -0.3, 0.0, 0.5]);

// Create a RAdam optimizer with default hyperparameters
let mut optimizer = RAdam::new(0.001);

// Update parameters
let new_params = optimizer.step(&params, &gradients).unwrap();

Implementations§

Source§

impl<A: Float + ScalarOperand + Debug + Send + Sync> RAdam<A>

Source

pub fn new(learning_rate: A) -> Self

Creates a new RAdam optimizer with the given learning rate and default settings

§Arguments
  • learning_rate - The learning rate for parameter updates
Source

pub fn new_with_config( learning_rate: A, beta1: A, beta2: A, epsilon: A, weight_decay: A, ) -> Self

Creates a new RAdam optimizer with the full configuration

§Arguments
  • learning_rate - The learning rate for parameter updates
  • beta1 - Exponential decay rate for the first moment estimates (default: 0.9)
  • beta2 - Exponential decay rate for the second moment estimates (default: 0.999)
  • epsilon - Small constant for numerical stability (default: 1e-8)
  • weight_decay - Weight decay factor (default: 0.0)
Source

pub fn set_beta1(&mut self, beta1: A) -> &mut Self

Sets the beta1 parameter

Source

pub fn get_beta1(&self) -> A

Gets the beta1 parameter

Source

pub fn set_beta2(&mut self, beta2: A) -> &mut Self

Sets the beta2 parameter

Source

pub fn get_beta2(&self) -> A

Gets the beta2 parameter

Source

pub fn set_epsilon(&mut self, epsilon: A) -> &mut Self

Sets the epsilon parameter

Source

pub fn get_epsilon(&self) -> A

Gets the epsilon parameter

Source

pub fn set_weight_decay(&mut self, weight_decay: A) -> &mut Self

Sets the weight decay parameter

Source

pub fn get_weight_decay(&self) -> A

Gets the weight decay parameter

Source

pub fn learning_rate(&self) -> A

Gets the current learning rate

Source

pub fn set_lr(&mut self, lr: A)

Sets the learning rate

Source

pub fn reset(&mut self)

Resets the internal state of the optimizer

Trait Implementations§

Source§

impl<A: Clone + Float + ScalarOperand + Debug> Clone for RAdam<A>

Source§

fn clone(&self) -> RAdam<A>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Debug + Float + ScalarOperand + Debug> Debug for RAdam<A>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A, D> Optimizer<A, D> for RAdam<A>
where A: Float + ScalarOperand + Debug + Send + Sync + From<f64>, D: Dimension,

Source§

fn step( &mut self, params: &Array<A, D>, gradients: &Array<A, D>, ) -> Result<Array<A, D>>

Updates parameters using the given gradients Read more
Source§

fn get_learning_rate(&self) -> A

Gets the current learning rate
Source§

fn set_learning_rate(&mut self, learning_rate: A)

Sets a new learning rate
Source§

fn step_list( &mut self, params_list: &[&Array<A, D>], gradients_list: &[&Array<A, D>], ) -> Result<Vec<Array<A, D>>>

Updates multiple parameter arrays at once Read more

Auto Trait Implementations§

§

impl<A> Freeze for RAdam<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for RAdam<A>
where A: RefUnwindSafe,

§

impl<A> Send for RAdam<A>
where A: Send,

§

impl<A> Sync for RAdam<A>
where A: Sync,

§

impl<A> Unpin for RAdam<A>
where A: Unpin,

§

impl<A> UnwindSafe for RAdam<A>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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