Trait ApplyGradientExt

pub trait ApplyGradientExt<Delta>: ApplyGradient<Delta> {
    type Velocity;

    // Required methods
    fn apply_gradient_with_momentum(
        &mut self,
        grad: &Delta,
        lr: Self::Elem,
        momentum: Self::Elem,
        velocity: &mut Self::Velocity,
    ) -> Result<Self::Output>;
    fn apply_gradient_with_decay_and_momentum(
        &mut self,
        grad: &Delta,
        lr: Self::Elem,
        decay: Self::Elem,
        momentum: Self::Elem,
        velocity: &mut Self::Velocity,
    ) -> Result<Self::Output>;
}

This trait extends the ApplyGradient trait by allowing for momentum-based optimization

Required Associated Types

type Velocity

Required Methods

fn apply_gradient_with_momentum( &mut self, grad: &Delta, lr: Self::Elem, momentum: Self::Elem, velocity: &mut Self::Velocity, ) -> Result<Self::Output>

fn apply_gradient_with_decay_and_momentum( &mut self, grad: &Delta, lr: Self::Elem, decay: Self::Elem, momentum: Self::Elem, velocity: &mut Self::Velocity, ) -> Result<Self::Output>

Implementations on Foreign Types

impl<A, S, T, D> ApplyGradientExt<ArrayBase<T, D>> for ArrayBase<S, D>

where A: Float + FromPrimitive + ScalarOperand, S: DataMut<Elem = A>, T: Data<Elem = A>, D: Dimension,

type Velocity = ArrayBase<OwnedRepr<A>, D>

fn apply_gradient_with_momentum( &mut self, grad: &ArrayBase<T, D>, lr: A, momentum: A, velocity: &mut Self::Velocity, ) -> Result<Self::Output>

fn apply_gradient_with_decay_and_momentum( &mut self, grad: &ArrayBase<T, D>, lr: A, decay: A, momentum: A, velocity: &mut Self::Velocity, ) -> Result<Self::Output>

Implementors

impl<A, S, T, D> ApplyGradientExt<ParamsBase<T, D>> for ParamsBase<S, D>

where A: Float + FromPrimitive + ScalarOperand, S: DataMut<Elem = A>, T: Data<Elem = A>, D: Dimension,

type Velocity = ParamsBase<OwnedRepr<A>, D>