Skip to main content

PagedAdamWState

Struct PagedAdamWState 

Source
pub struct PagedAdamWState {
    pub exp_avg: HashMap<String, Tensor>,
    pub exp_avg_sq: HashMap<String, Tensor>,
    pub steps: HashMap<String, usize>,
    pub page_size: usize,
    pub max_gpu_memory: usize,
    pub current_gpu_usage: usize,
    /* private fields */
}
Expand description

Paged optimizer state for CPU offloading.

Stores optimizer states (momentum, variance) on CPU and pages them to GPU as needed during parameter updates. This enables training large models on limited VRAM by trading off memory for compute.

Matches Python QLoRA’s --optim paged_adamw_32bit behavior.

Fields§

§exp_avg: HashMap<String, Tensor>

First moment estimates (CPU tensors, paged to GPU on demand).

§exp_avg_sq: HashMap<String, Tensor>

Second moment estimates (CPU tensors, paged to GPU on demand).

§steps: HashMap<String, usize>

Step counts per parameter.

§page_size: usize

Page size in bytes.

§max_gpu_memory: usize

Maximum GPU memory for optimizer states (0 = unlimited).

§current_gpu_usage: usize

Current GPU memory usage (bytes).

Implementations§

Source§

impl PagedAdamWState

Source

pub fn new(page_size: usize, max_gpu_memory: usize) -> PagedAdamWState

Create new paged optimizer state.

Source

pub fn init_param( &mut self, name: &str, shape: &[usize], _device: &Device, ) -> Result<(), QLoraError>

Initialize state for a parameter.

§Errors

Returns error if tensor creation fails.

Source

pub fn page_to_device( &mut self, name: &str, device: &Device, ) -> Result<(Tensor, Tensor), QLoraError>

Page state to GPU for update, returns (exp_avg, exp_avg_sq) on target device.

Updates LRU tracking and GPU memory usage.

§Errors

Returns error if device transfer fails.

Source

pub fn page_to_cpu( &mut self, name: &str, exp_avg: &Tensor, exp_avg_sq: &Tensor, ) -> Result<(), QLoraError>

Page state back to CPU after update.

Updates GPU memory tracking.

§Errors

Returns error if device transfer fails.

Source

pub fn increment_step(&mut self, name: &str)

Increment step count for a parameter.

Source

pub fn get_step(&self, name: &str) -> usize

Get step count for a parameter.

Source

pub fn is_gpu_resident(&self, name: &str) -> bool

Check if a parameter’s optimizer state is currently GPU-resident.

Source

pub fn gpu_resident_count(&self) -> usize

Get the number of parameters currently GPU-resident.

Trait Implementations§

Source§

impl Debug for PagedAdamWState

Source§

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

Formats the value using the given formatter. Read more

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,