Struct burn::optim::momentum::Momentum

pub struct Momentum<B>where
    B: Backend,
{ /* private fields */ }

Expand description

Momemtum implementation that transforms gradients.

Implementations§

§

impl Momentum
where B: Backend,

pub fn new(config: &MomentumConfig) -> Momentum

Creates a new momentum from a config.

pub fn transform<const D: usize>( &self, grad: Tensor<B, D>, state: Option<MomentumState<B, D>>, ) -> (Tensor<B, D>, MomentumState<B, D>)

Transforms a gradient.

§Arguments

grad - Gradient to transform.
state - State of the optimizer.

§Returns

grad - Transformed gradient.
state - State of the optimizer.

Trait Implementations§

§

impl Clone for Momentum
where B: Clone + Backend, ::FloatElem: Clone,

§

fn clone(&self) -> Momentum

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Momentum
where ::FloatElem: UnwindSafe,

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.

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> CloneToUninit for T
where T: Clone,

source §

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

§