Skip to main content

ScheduleFreeAdamW

Struct ScheduleFreeAdamW 

Source
pub struct ScheduleFreeAdamW { /* private fields */ }
Expand description

Schedule-free AdamW optimizer.

Maintains both training sequence (x) and evaluation sequence (y). During training, gradients are computed w.r.t. x_t. During evaluation, use y_t for better generalization.

§Algorithm

# Training step:
m_t = β₁ * m_{t-1} + (1 - β₁) * g_t
v_t = β₂ * v_{t-1} + (1 - β₂) * g_t²
x_t = x_{t-1} - lr * m_t / (√v_t + ε) - lr * λ * x_{t-1}  # weight decay

# Evaluation sequence (exponential moving average):
y_t = (1 - γ) * x_t + γ * y_{t-1}

# At test time, use y_t instead of x_t

§Example

use tensorlogic_train::{ScheduleFreeAdamW, ScheduleFreeConfig};
use scirs2_core::ndarray::Array2;
use std::collections::HashMap;

let config = ScheduleFreeConfig::default()
    .with_lr(0.001)
    .with_warmup_steps(1000);

let mut optimizer = ScheduleFreeAdamW::new(config);

// Training mode - use training parameters
optimizer.set_training_mode(true);

// ... compute gradients ...

// Evaluation mode - switch to averaged parameters
optimizer.set_training_mode(false);
let eval_params = optimizer.get_eval_parameters();

Implementations§

Source§

impl ScheduleFreeAdamW

Source

pub fn new(config: ScheduleFreeConfig) -> Self

Create a new Schedule-Free AdamW optimizer.

Source

pub fn set_training_mode(&mut self, training: bool)

Set training mode.

When training_mode = true, use train_params (x_t) for gradients. When training_mode = false, use eval_params (y_t) for evaluation.

Source

pub fn is_training(&self) -> bool

Get current training mode.

Source

pub fn get_eval_parameters(&self) -> &HashMap<String, Array2<f64>>

Get evaluation parameters (for inference).

Source

pub fn get_train_parameters(&self) -> &HashMap<String, Array2<f64>>

Get training parameters (for gradient computation).

Trait Implementations§

Source§

impl Clone for ScheduleFreeAdamW

Source§

fn clone(&self) -> ScheduleFreeAdamW

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 Debug for ScheduleFreeAdamW

Source§

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

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

impl Optimizer for ScheduleFreeAdamW

Source§

fn zero_grad(&mut self)

Zero all gradients.
Source§

fn get_lr(&self) -> f64

Get current learning rate.
Source§

fn set_lr(&mut self, lr: f64)

Set learning rate.
Source§

fn step( &mut self, parameters: &mut HashMap<String, Array2<f64>>, gradients: &HashMap<String, Array2<f64>>, ) -> TrainResult<()>

Update parameters with computed gradients.
Source§

fn state_dict(&self) -> HashMap<String, Vec<f64>>

Get optimizer state for checkpointing.
Source§

fn load_state_dict(&mut self, _state: HashMap<String, Vec<f64>>)

Load optimizer state from checkpoint.

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