Skip to main content

CheckpointManager

Struct CheckpointManager 

Source
pub struct CheckpointManager<T: Float + Debug + ScalarOperand + Send + Sync + 'static> { /* private fields */ }
Expand description

Checkpoint management

Implementations§

Source§

impl<T: Float + Debug + ScalarOperand + Send + Sync + 'static> CheckpointManager<T>

Source

pub fn new(config: &TransformerBasedOptimizerConfig<T>) -> Result<Self>

Build a checkpoint manager whose auto-save cadence follows config.

The auto-save frequency used to be a fixed 100 steps regardless of the optimizer’s configuration; it now tracks StateConfig::from_optimizer_config, which derives it from performance_config.metrics_interval.

Source

pub fn auto_save_config(&self) -> &AutoSaveConfig

The auto-save policy this manager was built with.

Source

pub fn maybe_auto_save( &mut self, step: usize, snapshot: OptimizerStateSnapshot<T>, ) -> Result<Option<String>>

Save snapshot if step falls on the configured auto-save cadence.

Returns the new checkpoint id, or None when auto-save is disabled or step is not a save point. Auto-saves are named auto_<step> and are capped at AutoSaveConfig::max_auto_saves independently of the explicit-checkpoint limit, oldest evicted first, so a long run cannot grow the store without bound. step == 0 saves the initial state.

Without this, auto_save_config was populated at construction and never read by anything: the auto-save policy existed only as a value.

Source

pub fn auto_save_count(&self) -> usize

Number of auto-saved checkpoints currently retained.

Source

pub fn save_checkpoint( &mut self, name: String, snapshot: OptimizerStateSnapshot<T>, ) -> Result<String>

Source

pub fn load_checkpoint( &self, checkpoint_id: &str, ) -> Result<OptimizerStateSnapshot<T>>

Source

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

Source

pub fn delete_checkpoint(&mut self, checkpoint_id: &str) -> Result<bool>

Source

pub fn get_checkpoint_count(&self) -> usize

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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