Ranger

Struct Ranger 

Source
pub struct Ranger<T: Float + ScalarOperand> { /* private fields */ }
Expand description

Ranger optimizer configuration

Ranger combines RAdam (Rectified Adam) with Lookahead mechanism. This standalone implementation integrates both algorithms efficiently.

§Key Features

  • Fast convergence from RAdam’s variance rectification
  • Stability from Lookahead’s slow weight trajectory
  • Reduced sensitivity to hyperparameter choices
  • Better generalization than Adam or RAdam alone

§Type Parameters

  • T: Floating-point type (f32 or f64)

Implementations§

Source§

impl<T: Float + ScalarOperand> Ranger<T>

Source

pub fn new( learning_rate: T, beta1: T, beta2: T, epsilon: T, weight_decay: T, lookahead_k: usize, lookahead_alpha: T, ) -> Result<Self>

Create a new Ranger optimizer

§Arguments
  • learning_rate: Learning rate for RAdam (typically 0.001)
  • beta1: First moment decay rate (typically 0.9)
  • beta2: Second moment decay rate (typically 0.999)
  • epsilon: Small constant for numerical stability (typically 1e-8)
  • weight_decay: L2 regularization coefficient (typically 0.0)
  • lookahead_k: Number of fast updates per slow update (typically 5-6)
  • lookahead_alpha: Interpolation factor for slow weights (typically 0.5)
§Example
use optirs_core::optimizers::Ranger;

let optimizer = Ranger::<f32>::new(
    0.001,  // learning_rate
    0.9,    // beta1
    0.999,  // beta2
    1e-8,   // epsilon
    0.0,    // weight_decay
    5,      // lookahead_k
    0.5     // lookahead_alpha
).unwrap();
Source

pub fn step( &mut self, params: ArrayView1<'_, T>, grads: ArrayView1<'_, T>, ) -> Result<Array1<T>>

Perform a single optimization step

Combines RAdam (fast weights) with Lookahead (slow weights)

§Example
use optirs_core::optimizers::Ranger;
use scirs2_core::ndarray_ext::array;

let mut optimizer = Ranger::<f32>::default();
let params = array![1.0, 2.0, 3.0];
let grads = array![0.1, 0.2, 0.3];

let updated_params = optimizer.step(params.view(), grads.view()).unwrap();
Source

pub fn step_count(&self) -> usize

Get the number of optimization steps performed

Source

pub fn slow_update_count(&self) -> usize

Get the number of slow weight updates performed

Source

pub fn reset(&mut self)

Reset the optimizer state

Source

pub fn slow_weights(&self) -> Option<&Array1<T>>

Get the slow weights (Lookahead trajectory)

Source

pub fn is_rectified(&self) -> bool

Check if variance rectification is active

Trait Implementations§

Source§

impl<T: Clone + Float + ScalarOperand> Clone for Ranger<T>

Source§

fn clone(&self) -> Ranger<T>

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<T: Debug + Float + ScalarOperand> Debug for Ranger<T>

Source§

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

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

impl<T: Float + ScalarOperand> Default for Ranger<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, T> Deserialize<'de> for Ranger<T>
where T: Deserialize<'de> + Float + ScalarOperand,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T> Serialize for Ranger<T>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Ranger<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Ranger<T>
where T: RefUnwindSafe,

§

impl<T> Send for Ranger<T>
where T: Send,

§

impl<T> Sync for Ranger<T>
where T: Sync,

§

impl<T> Unpin for Ranger<T>
where T: Unpin,

§

impl<T> UnwindSafe for Ranger<T>

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<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,