Skip to main content

GradientAccumulator

Struct GradientAccumulator 

Source
pub struct GradientAccumulator<T> { /* private fields */ }
Expand description

Gradient accumulator for managing accumulated gradients

Implementations§

Source§

impl<T: Clone> GradientAccumulator<T>

Source

pub fn new(config: AccumulationConfig) -> Self

Source

pub fn accumulate(&mut self, gradients: Vec<T>)

Add gradients to accumulator

Source

pub fn is_ready(&self) -> bool

Check if ready to step (accumulated enough)

Source

pub fn step(&mut self) -> Vec<T>

Get accumulated gradients and optionally reset

Source

pub fn clear(&mut self)

Clear accumulated gradients

Source

pub fn count(&self) -> usize

Get current accumulation count

Source

pub fn config(&self) -> &AccumulationConfig

Auto Trait Implementations§

§

impl<T> Freeze for GradientAccumulator<T>

§

impl<T> RefUnwindSafe for GradientAccumulator<T>
where T: RefUnwindSafe,

§

impl<T> Send for GradientAccumulator<T>
where T: Send,

§

impl<T> Sync for GradientAccumulator<T>
where T: Sync,

§

impl<T> Unpin for GradientAccumulator<T>
where T: Unpin,

§

impl<T> UnwindSafe for GradientAccumulator<T>
where T: UnwindSafe,

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