Skip to main content

Adafactor

Struct Adafactor 

Source
pub struct Adafactor {
    pub lr: Option<f32>,
    pub beta2_decay: f32,
    pub eps1: f32,
    pub eps2: f32,
    pub clip_threshold: f32,
    pub weight_decay: f32,
    /* private fields */
}
Expand description

Adafactor — factored-second-moment optimizer.

Per-tensor state: a rows-vector + a cols-vector for 2-D parameters (sublinear in rows·cols), or a full EMA for non-2-D.

Fields§

§lr: Option<f32>

Optional manual learning rate. None ⇒ use the “relative step” rule min(1/√t, 1e-2) · max(ε₂, RMS(θ)) from the paper. Default None.

§beta2_decay: f32

β₂_t decay-rate exponent. β₂_t = 1 − tˣ with x = -0.8 (default) means slow decay early, full decay asymptotically.

§eps1: f32

Squared-gradient stability constant added before each row / column average. Default 1e-30.

§eps2: f32

RMS-of-parameter floor for the relative-step rule. Default 1e-3.

§clip_threshold: f32

Update-RMS clipping threshold (Shazeer & Stern §6). Default 1.0.

§weight_decay: f32

Decoupled weight-decay coefficient λ. Default 0.0.

Implementations§

Source§

impl Adafactor

Source

pub fn new() -> Self

Construct with paper defaults (no manual lr ⇒ relative step, decay_rate = -0.8, ε₁=1e-30, ε₂=1e-3, clip=1.0, λ=0.0).

Source

pub fn with_lr(self, lr: f32) -> Self

Switch from the relative-step rule to a manual learning rate.

Source

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

Override the decoupled-decay coefficient.

Trait Implementations§

Source§

impl Clone for Adafactor

Source§

fn clone(&self) -> Adafactor

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 Adafactor

Source§

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

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

impl Default for Adafactor

Source§

fn default() -> Self

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

impl Optimizer for Adafactor

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§

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.