Struct ClassWrapper

pub struct ClassWrapper<G: Gradients, M: ClassMarker> { /* private fields */ }

A wrapper type for gradients which overrides the class reported via Gradients::grad_iter_mut_with_class.

Trait Implementations

impl<G: Clone + Gradients, M: Clone + ClassMarker> Clone for ClassWrapper<G, M>

fn clone(&self) -> ClassWrapper<G, M>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<G: Debug + Gradients, M: Debug + ClassMarker> Debug for ClassWrapper<G, M>

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

Formats the value using the given formatter.

impl<G: Gradients, M: ClassMarker> Gradients for ClassWrapper<G, M>

type Concrete = <G as Gradients>::Concrete

fn grad_iter(&self) -> impl Iterator<Item = &Self::Concrete>

Returns an iterator over each parameter gradient.

fn grad_iter_mut(&mut self) -> impl Iterator<Item = &mut Self::Concrete>

Returns a mutable iterator over each parameter gradient.

fn grad_iter_mut_with_class( &mut self, ) -> impl Iterator<Item = (&mut Self::Concrete, GradClass)>

Returns a mutable iterator over each parameter gradient, yielding both the parameter gradient and its GradClass.

fn into_grads(self) -> impl Iterator<Item = Self::Concrete>

Consumes the object, returning an iterator of each parameter gradient.

fn empty() -> Self

Returns an empty gradient object

fn merge(&mut self, other: Self, weight: f32)

Merges the values from the given gradient into the current one, based on the given weight.

fn add(&mut self, other: Self)

fn scale(&mut self, s: f32)

Scales each gradient by the given constant.

fn cosine_similarity(&self, other: &Self) -> Option<f32>

Returns the cosine similarity between the two gradients.