GradientAccumulator

Struct GradientAccumulator 

Source
pub struct GradientAccumulator<A: Float, D: Dimension> { /* private fields */ }
Expand description

Gradient accumulator for micro-batch training

Implementations§

Source§

impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> GradientAccumulator<A, D>

Source

pub fn new(_targetaccumulations: usize, mode: AccumulationMode) -> Self

Create a new gradient accumulator

Source

pub fn initialize(&mut self, gradients: &[Array<A, D>]) -> Result<()>

Initialize accumulator with gradient shapes

Source

pub fn accumulate(&mut self, gradients: &[Array<A, D>]) -> Result<()>

Accumulate gradients from a micro-batch

Source

pub fn is_ready(&self) -> bool

Check if accumulation is complete

Source

pub fn get_and_reset(&mut self) -> Result<Vec<Array<A, D>>>

Get accumulated gradients and reset accumulator

Source

pub fn reset(&mut self)

Reset accumulator state

Source

pub fn accumulation_count(&self) -> usize

Get current accumulation count

Source

pub fn target_accumulations(&self) -> usize

Get target accumulation count

Source

pub fn set_target_accumulations(&mut self, target: usize)

Set new target accumulation count

Source

pub fn mode(&self) -> AccumulationMode

Get accumulation mode

Source

pub fn set_mode(&mut self, mode: AccumulationMode)

Set accumulation mode

Source

pub fn is_initialized(&self) -> bool

Check if accumulator is initialized

Source

pub fn progress(&self) -> f64

Get current progress as a fraction (0.0 to 1.0)

Trait Implementations§

Source§

impl<A: Debug + Float, D: Debug + Dimension> Debug for GradientAccumulator<A, D>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<A, D> Freeze for GradientAccumulator<A, D>

§

impl<A, D> RefUnwindSafe for GradientAccumulator<A, D>

§

impl<A, D> Send for GradientAccumulator<A, D>
where A: Send,

§

impl<A, D> Sync for GradientAccumulator<A, D>
where A: Sync,

§

impl<A, D> Unpin for GradientAccumulator<A, D>
where D: Unpin,

§

impl<A, D> UnwindSafe for GradientAccumulator<A, D>

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