pub struct MicroBatchTrainer<A: Float, D: Dimension> { /* private fields */ }Expand description
Micro-batch trainer that uses gradient accumulation
Implementations§
Source§impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> MicroBatchTrainer<A, D>
impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> MicroBatchTrainer<A, D>
Sourcepub fn new(
micro_batch_size: usize,
effective_batch_size: usize,
mode: AccumulationMode,
) -> Result<Self>
pub fn new( micro_batch_size: usize, effective_batch_size: usize, mode: AccumulationMode, ) -> Result<Self>
Create a new micro-batch trainer
Sourcepub fn process_micro_batch(&mut self, gradients: &[Array<A, D>]) -> Result<()>
pub fn process_micro_batch(&mut self, gradients: &[Array<A, D>]) -> Result<()>
Process a micro-batch and accumulate gradients
Sourcepub fn ready_for_step(&self) -> bool
pub fn ready_for_step(&self) -> bool
Check if ready for optimizer step
Sourcepub fn get_accumulated_gradients(&mut self) -> Result<Vec<Array<A, D>>>
pub fn get_accumulated_gradients(&mut self) -> Result<Vec<Array<A, D>>>
Get accumulated gradients for optimizer step
Sourcepub fn micro_batch_size(&self) -> usize
pub fn micro_batch_size(&self) -> usize
Get micro-batch size
Sourcepub fn effective_batch_size(&self) -> usize
pub fn effective_batch_size(&self) -> usize
Get effective batch size
Sourcepub fn set_effective_batch_size(
&mut self,
effective_batchsize: usize,
) -> Result<()>
pub fn set_effective_batch_size( &mut self, effective_batchsize: usize, ) -> Result<()>
Set new effective batch size
Trait Implementations§
Auto Trait Implementations§
impl<A, D> Freeze for MicroBatchTrainer<A, D>
impl<A, D> RefUnwindSafe for MicroBatchTrainer<A, D>where
D: RefUnwindSafe,
A: RefUnwindSafe,
impl<A, D> Send for MicroBatchTrainer<A, D>where
A: Send,
impl<A, D> Sync for MicroBatchTrainer<A, D>where
A: Sync,
impl<A, D> Unpin for MicroBatchTrainer<A, D>where
D: Unpin,
impl<A, D> UnwindSafe for MicroBatchTrainer<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.