Skip to main content

Mars

Struct Mars 

Source
pub struct Mars {
    pub lr: f32,
    pub beta1: f32,
    pub beta2: f32,
    pub eps: f32,
    pub weight_decay: f32,
    pub gamma: f32,
    pub clip_c: bool,
    /* private fields */
}
Expand description

MARS — variance-reduced AdamW. Per-tensor state: three f32 buffers (m, v, previous-gradient cache).

Fields§

§lr: f32

Learning rate.

§beta1: f32

First-moment EMA decay β₁. Default 0.95.

§beta2: f32

Second-moment EMA decay β₂. Default 0.99.

§eps: f32

Denominator stability constant. Default 1e-8.

§weight_decay: f32

Decoupled weight-decay coefficient λ. Default 0.0.

§gamma: f32

Variance-reduction strength γ (Yuan et al. eq. 7). 0.0 collapses MARS to plain AdamW; 1.0 is the full prescription. Default 0.025.

§clip_c: bool

If true, clip the variance-reduced surrogate c_t to unit norm per tensor (matches the “MARS-AdamW” recipe and keeps the VR kick from exploding when g_{t-1} is unrelated noise on early steps).

Implementations§

Source§

impl Mars

Source

pub fn new(lr: f32) -> Self

Construct with (β₁, β₂, ε, λ, γ, clip_c) = (0.95, 0.99, 1e-8, 0.0, 0.025, true).

Source

pub fn with_betas(self, b1: f32, b2: f32) -> Self

Override (β₁, β₂).

Source

pub fn with_weight_decay(self, wd: f32) -> Self

Override the decoupled-decay coefficient.

Trait Implementations§

Source§

impl Clone for Mars

Source§

fn clone(&self) -> Mars

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Mars

Source§

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

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

impl Optimizer for Mars

Source§

fn step( &mut self, name: &str, _shape: &[usize], param: &mut [f32], grad: &[f32], )

Source§

fn end_iteration(&mut self)

Advance the global step counter. Most algorithms increment per call to [step], so most implementations leave this a no-op.
Source§

fn lr_scale(&self, _name: &str) -> f32

Per-tensor multiplier on the effective learning rate. Default is 1.0 for every name. Override when wrapping this crate to support per-name LR schedules (e.g. embedding-vs-attention splits, or the Gaussian-splat attribute-typed LR setup). The CPU impls in this crate currently honor this only when the caller passes a pre-scaled lr for the relevant call — backends are encouraged to consult it inside their fused kernel.

Auto Trait Implementations§

§

impl Freeze for Mars

§

impl RefUnwindSafe for Mars

§

impl Send for Mars

§

impl Sync for Mars

§

impl Unpin for Mars

§

impl UnsafeUnpin for Mars

§

impl UnwindSafe for Mars

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> 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> 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.