Struct GradStore

Source

pub struct GradStore(/* private fields */);

Expand description

A store for gradients, associating a tensor id to the corresponding gradient tensor, used for back propagation.

Implementations§

Source §

impl GradStore

Source

pub fn get_id(&self, id: TensorId) -> Option<&Tensor>

Get the gradient tensor corresponding to the given tensor id

Source

pub fn get(&self, tensor: &Tensor) -> Option<&Tensor>

Get the gradient tensor associated with the given tensor

Source

pub fn remove(&mut self, tensor: &Tensor) -> Option<Tensor>

Remove the gradient tensor associated with the given tensor, returning it if it exists

Source

pub fn insert(&mut self, tensor: &Tensor, grad: Tensor) -> Option<Tensor>

Insert a gradient tensor associated with the given tensor, returning the previous gradient tensor if it existed

Source

pub fn get_ids(&self) -> impl Iterator<Item = &TensorId>

Get the tensor ids of the stored gradient tensors

Trait Implementations§

Source §

impl Debug for GradStore

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for GradStore

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