Skip to main content

ExponentialMovingAverage

Struct ExponentialMovingAverage 

Source
pub struct ExponentialMovingAverage { /* private fields */ }
Expand description

Exponential Moving Average of model parameters.

Maintains shadow copies of parameters that are updated as a weighted running average: shadow = decay * shadow + (1 - decay) * param. This is commonly used to produce a smoothed version of model weights that often generalises better at inference time.

Implementations§

Source§

impl ExponentialMovingAverage

Source

pub fn new(decay: f32) -> Self

Creates a new EMA tracker with the given decay factor (e.g. 0.999).

Source

pub fn register(&mut self, params: &[Tensor])

Registers initial parameter values as shadow copies.

Source

pub fn update(&mut self, params: &[Tensor])

Updates shadow parameters: shadow = decay * shadow + (1 - decay) * param.

Panics if the number of tensors does not match the registered count or if any tensor length differs from its shadow counterpart.

Source

pub fn shadow_params(&self) -> &[Tensor]

Returns a reference to the shadow parameters.

Source

pub fn apply_shadow(&self, params: &mut [Tensor])

Copies shadow parameter values into the provided mutable slice.

Panics if the slice length does not match the shadow parameter count or if any tensor length differs.

Source

pub fn num_updates(&self) -> usize

Returns the number of update steps performed so far.

Auto Trait Implementations§

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.