Struct CenteredState 

pub struct CenteredState<B: Backend, const D: usize> {
    pub grad_avg: Option<Tensor<B, D>>,
    pub avg: Tensor<B, D>,
}

CenteredState is to store and pass optimizer step params.

Fields

grad_avg: Option<Tensor<B, D>>

The averaged gradient to calculate the centered gradient, if available.

avg: Tensor<B, D>

The current average value.

Implementations

impl<B: Backend, const D: usize> CenteredState<B, D>

pub fn new(grad_avg: Option<Tensor<B, D>>, avg: Tensor<B, D>) -> Self

Constructs a new CenteredState.

impl<B: Backend, const D: usize> CenteredState<B, D>

pub fn to_device(self, device: &B::Device) -> Self

Moves the state to a device.

Arguments

• device - Device to move the state to.

Returns

• self - Moved state.

Trait Implementations

impl<B: Clone + Backend, const D: usize> Clone for CenteredState<B, D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Backend, const D: usize> Record<B> for CenteredState<B, D>

type Item<S: PrecisionSettings> = CenteredStateItem<B, D, S>

Type of the item that can be serialized and deserialized.

fn into_item<S: PrecisionSettings>(self) -> Self::Item<S>

Convert the current record into the corresponding item that follows the given settings.

fn from_item<S: PrecisionSettings>( item: Self::Item<S>, device: &B::Device, ) -> Self

Convert the given item into a record.