Skip to main content

CheckpointManager

Struct CheckpointManager 

Source
pub struct CheckpointManager<T> { /* private fields */ }
Expand description

Manager for activation checkpointing

Implementations§

Source§

impl<T> CheckpointManager<T>
where T: Clone + Default + Send + Sync,

Source

pub fn new(config: CheckpointingConfig) -> Self

Create a new checkpoint manager

Source

pub fn with_memory_budget( memory_budget_mb: usize, avg_activation_mb: usize, ) -> Self

Create with automatic memory-based policy

Source

pub fn should_checkpoint(&self, layer_index: usize, total_layers: usize) -> bool

Check if layer should be checkpointed according to policy

Source

pub fn save_checkpoint( &self, layer_index: usize, activations: Vec<Tensor<T>>, ) -> Result<()>

Save a checkpoint for the given layer

Source

pub fn get_checkpoint( &self, layer_index: usize, ) -> Result<Option<Checkpoint<T>>>

Retrieve a checkpoint for the given layer

Source

pub fn restore_rng_state(&self, _rng_state: &[u8]) -> Result<()>

Restore RNG state previously captured by capture_rng_state.

The current scirs2_core RNG (a rand 0.10 ChaCha-backed generator) does not expose serializable PRNG state, so there is nothing that can be faithfully restored. This returns an honest UnsupportedOperation error instead of silently pretending the state was restored.

Source

pub fn record_recomputation(&self, compute_time_us: u64)

Record a recomputation event

Source

pub fn record_backward_pass(&self)

Record a backward pass

Source

pub fn get_statistics(&self) -> Result<CheckpointStatistics>

Get current statistics

Source

pub fn clear(&self) -> Result<()>

Clear all checkpoints

Source

pub fn checkpoint_count(&self) -> usize

Get number of active checkpoints

Source

pub fn total_memory_bytes(&self) -> usize

Get total memory used by checkpoints

Trait Implementations§

Source§

impl<T> Clone for CheckpointManager<T>
where T: Clone + Default + Send + Sync,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. 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<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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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