Skip to main content

PagedAdamW

Struct PagedAdamW 

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

Paged AdamW optimizer with CPU offloading.

Implements AdamW with optimizer state paging to CPU memory, matching Python’s paged_adamw_32bit from bitsandbytes.

§Memory Behavior

  • Optimizer states (exp_avg, exp_avg_sq) stored on CPU
  • States paged to GPU only during parameter update
  • Enables training 7B+ models on 24GB GPUs with QLoRA

Implementations§

Source§

impl PagedAdamW

Source

pub fn new( lr: f64, weight_decay: f64, page_size: usize, max_gpu_memory: usize, ) -> PagedAdamW

Create a new paged AdamW optimizer.

§Arguments
  • lr - Learning rate
  • weight_decay - Weight decay coefficient
  • page_size - Page size in bytes for CPU offloading
  • max_gpu_memory - Maximum GPU memory for optimizer states (0 = unlimited)
Source

pub fn with_betas(self, beta1: f64, beta2: f64) -> PagedAdamW

Create with custom betas.

Source

pub fn init(&mut self, params: &[(String, Tensor)]) -> Result<(), QLoraError>

Initialize optimizer state for parameters.

§Errors

Returns error if state initialization fails.

Source

pub fn set_lr(&mut self, lr: f64)

Set learning rate.

Source

pub fn lr(&self) -> f64

Get current learning rate.

Source

pub fn step_param( &mut self, name: &str, param: &mut Tensor, grad: &Tensor, ) -> Result<(), QLoraError>

Perform optimizer step for a single parameter.

Implements AdamW update with CPU paging:

m_t = β₁ * m_{t-1} + (1 - β₁) * g_t
v_t = β₂ * v_{t-1} + (1 - β₂) * g_t²
m̂_t = m_t / (1 - β₁^t)
v̂_t = v_t / (1 - β₂^t)
θ_t = θ_{t-1} - lr * (m̂_t / (√v̂_t + ε) + λ * θ_{t-1})
§Errors

Returns error if tensor operations fail.

Source

pub fn memory_stats(&self) -> (usize, usize)

Get memory usage statistics.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,