Skip to main content

CheckpointManager

Struct CheckpointManager 

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

Gradient checkpointing manager

Implementations§

Source§

impl CheckpointManager

Source

pub fn new(config: CheckpointConfig) -> Result<Self, OptimizerError>

Create a new checkpoint manager

Source

pub fn should_checkpoint(&self) -> bool

Check if a checkpoint should be saved at the current step

Source

pub fn save_checkpoint( &mut self, optimizer_state: Option<&[u8]>, gradients: Option<&HashMap<String, Vec<f32>>>, model_parameters: Option<&HashMap<String, Vec<f32>>>, loss: Option<f32>, learning_rate: f32, epoch: Option<usize>, ) -> Result<PathBuf, OptimizerError>

Save a checkpoint

Source

pub fn load_checkpoint( &self, checkpoint_path: &Path, ) -> Result<Checkpoint, OptimizerError>

Load a checkpoint

Source

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

Get the latest checkpoint path

Source

pub fn list_checkpoints(&self) -> Vec<&CheckpointMetadata>

Get all checkpoint metadata

Source

pub fn step(&mut self)

Increment current step

Source

pub fn current_step(&self) -> usize

Get current step

Source

pub fn set_step(&mut self, step: usize)

Set current step

Source

pub fn resume_from_latest( &mut self, ) -> Result<Option<Checkpoint>, OptimizerError>

Resume from the latest checkpoint

Source

pub fn cleanup(&mut self) -> Result<(), OptimizerError>

Clean up checkpoints manually

Source

pub fn statistics(&self) -> CheckpointStatistics

Get checkpoint 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<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, 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, 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