Struct burn::optim::GradientsAccumulator
pub struct GradientsAccumulator<M> { /* private fields */ }Expand description
Accumulate gradients into a single Gradients object.
Implementations§
§impl<M> GradientsAccumulator<M>
impl<M> GradientsAccumulator<M>
pub fn new() -> GradientsAccumulator<M>
pub fn new() -> GradientsAccumulator<M>
Create a new gradients accumulator.
§impl<M> GradientsAccumulator<M>
impl<M> GradientsAccumulator<M>
pub fn accumulate<B>(&mut self, module: &M, grads: GradientsParams)where
B: AutodiffBackend,
M: AutodiffModule<B>,
pub fn accumulate<B>(&mut self, module: &M, grads: GradientsParams)where
B: AutodiffBackend,
M: AutodiffModule<B>,
Accumulate the given gradients for each parameter in the given module.
pub fn grads(&mut self) -> GradientsParams
pub fn grads(&mut self) -> GradientsParams
Return the accumulated gradients and reset the accumulator state.
Trait Implementations§
§impl<M> Default for GradientsAccumulator<M>
impl<M> Default for GradientsAccumulator<M>
§fn default() -> GradientsAccumulator<M>
fn default() -> GradientsAccumulator<M>
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl<M> Freeze for GradientsAccumulator<M>
impl<M> !RefUnwindSafe for GradientsAccumulator<M>
impl<M> Send for GradientsAccumulator<M>where
M: Send,
impl<M> !Sync for GradientsAccumulator<M>
impl<M> Unpin for GradientsAccumulator<M>where
M: Unpin,
impl<M> !UnwindSafe for GradientsAccumulator<M>
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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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 more§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().