Skip to main content

GradientCheckpointer

Struct GradientCheckpointer 

Source
pub struct GradientCheckpointer {
    pub config: CheckpointerConfig,
    pub global_step: u64,
    /* private fields */
}
Expand description

Production-grade gradient checkpointing engine.

Collects GcGradientTensor objects via accumulate, combines them into a GcGradientCheckpoint via flush, and maintains a bounded history of the most recent checkpoints.

Fields§

§config: CheckpointerConfig

Runtime configuration.

§global_step: u64

Cumulative step counter. Incremented once per accumulate call.

Implementations§

Source§

impl GradientCheckpointer

Source

pub fn new(config: CheckpointerConfig) -> Self

Create a new checkpointer with the given configuration.

Source

pub fn accumulate(&mut self, gradient: GcGradientTensor)

Push a gradient tensor into the accumulation buffer for its layer.

The global step counter is incremented once per call.

Source

pub fn flush( &mut self, now: u64, ) -> Result<GcGradientCheckpoint, GradientCheckpointerError>

Flush accumulated gradients into a new checkpoint.

Applies the configured accumulation mode over all pending tensors for each layer, optionally clips the resulting global norm, computes a FNV-1a checksum, and stores the checkpoint. If the checkpoint count exceeds max_checkpoints, the oldest entry is evicted.

§Errors

Returns GradientCheckpointerError::NoAccumulatedGradients when there are no pending tensors.

Source

pub fn replay(&self, checkpoint: &GcGradientCheckpoint) -> Vec<GcGradientTensor>

Return gradient tensors from checkpoint sorted by layer_id.

Source

pub fn latest_checkpoint(&self) -> Option<&GcGradientCheckpoint>

Return a reference to the most recently flushed checkpoint, if any.

Source

pub fn checkpoint_by_id( &self, id: CheckpointId, ) -> Option<&GcGradientCheckpoint>

Return a reference to the checkpoint with the given id, if it still resides in the bounded history.

Source

pub fn diff( &self, a: &GcGradientCheckpoint, b: &GcGradientCheckpoint, ) -> HashMap<String, f64>

Compute the per-layer L2 distance between two checkpoints.

For each layer present in either checkpoint the function returns the L2 distance between the corresponding gradient value vectors. If a layer is absent in one of the checkpoints its contribution is 0.0.

Source

pub fn global_norm(&self, checkpoint: &GcGradientCheckpoint) -> f64

Compute the global L2 norm of a checkpoint (sqrt of sum of squared per-layer norms).

Source

pub fn pending_layers(&self) -> Vec<&str>

Return a sorted list of layer IDs that have pending (unflushed) gradients.

Source

pub fn pending_count(&self) -> usize

Return the total count of pending gradient tensors across all layers.

Source

pub fn stats(&self) -> GcCheckpointerStats

Return a snapshot of current checkpointer statistics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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