pub struct AutoCheckpointer<A: Float, D: Dimension> { /* private fields */ }Expand description
Automatic checkpointing manager for optimization workflows
Implementations§
Source§impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> AutoCheckpointer<A, D>
impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> AutoCheckpointer<A, D>
Sourcepub fn new(
_initial_strategy: CheckpointStrategy,
target_memoryratio: f64,
) -> Self
pub fn new( _initial_strategy: CheckpointStrategy, target_memoryratio: f64, ) -> Self
Create a new auto checkpointer
Sourcepub fn with_adaptation_frequency(self, frequency: usize) -> Self
pub fn with_adaptation_frequency(self, frequency: usize) -> Self
Set adaptation frequency
Sourcepub fn auto_step<F, Output>(
&mut self,
depth: usize,
input: &Array<A, D>,
forward_fn: F,
) -> Result<(Output, Option<Array<A, D>>)>
pub fn auto_step<F, Output>( &mut self, depth: usize, input: &Array<A, D>, forward_fn: F, ) -> Result<(Output, Option<Array<A, D>>)>
Execute a step with automatic checkpointing
Sourcepub fn checkpointer(&self) -> &GradientCheckpointer<A, D>
pub fn checkpointer(&self) -> &GradientCheckpointer<A, D>
Get checkpointer reference
Sourcepub fn checkpointer_mut(&mut self) -> &mut GradientCheckpointer<A, D>
pub fn checkpointer_mut(&mut self) -> &mut GradientCheckpointer<A, D>
Get mutable checkpointer reference
Sourcepub fn get_memory_stats(&self) -> MemoryStats
pub fn get_memory_stats(&self) -> MemoryStats
Get memory usage statistics
Trait Implementations§
Auto Trait Implementations§
impl<A, D> Freeze for AutoCheckpointer<A, D>
impl<A, D> RefUnwindSafe for AutoCheckpointer<A, D>where
D: RefUnwindSafe,
A: RefUnwindSafe,
impl<A, D> Send for AutoCheckpointer<A, D>where
A: Send,
impl<A, D> Sync for AutoCheckpointer<A, D>where
A: Sync,
impl<A, D> Unpin for AutoCheckpointer<A, D>where
D: Unpin,
impl<A, D> UnwindSafe for AutoCheckpointer<A, D>where
D: UnwindSafe,
A: RefUnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.