Skip to main content

ActivationCheckpointer

Struct ActivationCheckpointer 

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

Manages activation checkpoints for a multi-layer forward pass.

Stores activations at designated layer boundaries so they can be used during backpropagation without keeping every intermediate result in memory.

Implementations§

Source§

impl ActivationCheckpointer

Source

pub fn new(config: CheckpointConfig) -> Self

Create a new checkpointer with the given configuration.

Source

pub fn save( &mut self, layer_idx: usize, activation: Array1<f32>, ) -> ModelResult<()>

Save an activation at the given layer index.

If use_mixed_precision is enabled, the activation is quantised before storage.

§Errors

Returns an error if max_checkpoints would be exceeded and the layer is not a checkpoint boundary.

Source

pub fn get(&self, layer_idx: usize) -> ModelResult<&Array1<f32>>

Retrieve the checkpointed activation at the given layer.

§Errors

Returns an error if no checkpoint exists for layer_idx.

Source

pub fn clear(&mut self)

Clear all stored checkpoints and reset memory accounting.

Source

pub fn memory_saved_bytes(&self) -> usize

Estimated bytes of memory saved by not storing non-checkpointed activations.

This value is updated during checkpointed_forward calls.

Source

pub fn memory_stored_bytes(&self) -> usize

Bytes currently stored in checkpoints.

Source

pub fn num_checkpoints(&self) -> usize

Number of non-None checkpoints currently held.

Source

pub fn is_checkpoint_layer(&self, layer_idx: usize) -> bool

Whether a given layer index is a checkpoint boundary according to the current configuration.

Source

pub fn checkpointed_forward<F>( &mut self, input: &Array1<f32>, layers: &[usize], forward_fn: F, ) -> ModelResult<Array1<f32>>
where F: Fn(&Array1<f32>, usize) -> ModelResult<Array1<f32>>,

Run a checkpointed forward pass through the given layers.

The forward_fn is called sequentially for each layer in layers, receiving the current activation and the layer index. Activations at checkpoint boundaries are saved; others are discarded (their memory cost is recorded in bytes_saved).

§Parameters
  • input: the initial activation fed into the first layer.
  • layers: ordered list of layer indices to process.
  • forward_fn: Fn(&Array1<f32>, usize) -> ModelResult<Array1<f32>>; applies one layer’s computation.
§Returns

The activation after all layers have been applied.

Source

pub fn recompute_from_checkpoint<F>( &self, target_layer: usize, layers: &[usize], forward_fn: F, ) -> ModelResult<Array1<f32>>
where F: Fn(&Array1<f32>, usize) -> ModelResult<Array1<f32>>,

Recompute activations from the nearest checkpoint up to target_layer.

This is used during the backward pass: find the closest checkpoint before target_layer, then replay the forward function from there.

§Parameters
  • target_layer: the layer whose activation is needed.
  • layers: the full ordered list of layer indices.
  • forward_fn: the same forward function used during the forward pass.
§Returns

The recomputed activation at target_layer.

Source

pub fn config(&self) -> &CheckpointConfig

Return the configuration.

Trait Implementations§

Source§

impl Clone for ActivationCheckpointer

Source§

fn clone(&self) -> ActivationCheckpointer

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 ActivationCheckpointer

Source§

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

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> 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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

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,