Skip to main content

Muon

Struct Muon 

Source
pub struct Muon {
    pub lr: f32,
    pub momentum: f32,
    pub nesterov: bool,
    pub weight_decay: f32,
    pub ns_steps: u32,
    pub ns_coeffs: (f32, f32, f32),
    /* private fields */
}
Expand description

Muon — Momentum-Orthogonalized-by-Newton-Schulz.

Per-tensor state: one momentum buffer per matrix (half of Adam’s footprint, like Lion).

Fields§

§lr: f32

Learning rate. The Newton–Schulz update has roughly unit Frobenius norm per column, so this is on the same scale as SGD’s lr — typically 2e-2 to 5e-2.

§momentum: f32

Polyak momentum coefficient. Default 0.95.

§nesterov: bool

Use Nesterov lookahead inside the matrix being orthogonalized. Default true.

§weight_decay: f32

Decoupled weight-decay coefficient λ. Default 0.0.

§ns_steps: u32

Newton–Schulz iteration count. 5 is the published default; 3 is enough for most well-conditioned matrices.

§ns_coeffs: (f32, f32, f32)

(a, b, c) coefficients of the cubic Newton–Schulz iteration X ← a·X + b·(XXᵀ)X + c·(XXᵀ)²X. Defaults match Jordan et al.

Implementations§

Source§

impl Muon

Source

pub fn new(lr: f32) -> Self

Construct with (μ, nesterov, λ, ns_steps) = (0.95, true, 0.0, 5) and the published NS coefficients.

Source

pub fn with_momentum(self, mu: f32) -> Self

Override the Polyak momentum coefficient.

Source

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

Override the decoupled-decay coefficient.

Source

pub fn with_ns_steps(self, n: u32) -> Self

Override the Newton–Schulz iteration count.

Trait Implementations§

Source§

impl Clone for Muon

Source§

fn clone(&self) -> Muon

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 Muon

Source§

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

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

impl Optimizer for Muon

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 Muon

§

impl RefUnwindSafe for Muon

§

impl Send for Muon

§

impl Sync for Muon

§

impl Unpin for Muon

§

impl UnsafeUnpin for Muon

§

impl UnwindSafe for Muon

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.