EMA

Struct EMA 

Source
pub struct EMA<B>
where B: Backend,
{ /* private fields */ }
Expand description

Exponential Moving Average of model parameters.

Maintains a shadow copy that is a smoothed version of training parameters.

§Example

let mut ema = EMA::new(model.parameters(), 0.999);

// Training loop:
optimizer.step(&grads)?;
ema.update(&model.parameters())?;

// Evaluation:
ema.apply()?;             // Write EMA weights into model
let output = model.forward(input)?;
ema.restore()?;           // Restore training weights

Implementations§

Source§

impl<B> EMA<B>
where B: Backend,

Source

pub fn new(params: Vec<Tensor<B>>, decay: f64) -> Result<EMA<B>, Error>

Create a new EMA tracker.

§Arguments
  • params: The model parameters to track
  • decay: Decay rate (typical: 0.999 or 0.9999)
Source

pub fn update(&mut self, current_params: &[Tensor<B>]) -> Result<(), Error>

Update the EMA shadow parameters with current model parameters.

Call this after each optimizer step.

Source

pub fn update_with_warmup( &mut self, current_params: &[Tensor<B>], ) -> Result<(), Error>

Update using an adjusted decay that ramps up during early training.

The effective decay is: min(decay, (1 + num_updates) / (10 + num_updates)) This prevents the EMA from being too biased toward initial values.

Source

pub fn apply(&mut self) -> Result<(), Error>

Apply EMA parameters to the model (for evaluation).

This saves the current training parameters so they can be restored with restore().

Source

pub fn restore(&mut self) -> Result<(), Error>

Restore training parameters after apply().

Source

pub fn decay(&self) -> f64

Get the decay rate.

Source

pub fn num_updates(&self) -> u64

Get the number of updates performed.

Source

pub fn shadow_values(&self, index: usize) -> &[f64]

Get the shadow (EMA) values for a specific parameter index.

Auto Trait Implementations§

§

impl<B> Freeze for EMA<B>

§

impl<B> RefUnwindSafe for EMA<B>
where <B as Backend>::Device: RefUnwindSafe,

§

impl<B> Send for EMA<B>

§

impl<B> Sync for EMA<B>

§

impl<B> Unpin for EMA<B>

§

impl<B> UnwindSafe for EMA<B>
where <B as Backend>::Device: RefUnwindSafe,

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V