Struct CenteredState

Source

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

Expand description

CenteredState is to store and pass optimizer step params.

Fields§

§grad_avg: Option<Tensor<D>>

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

§avg: Tensor<D>

The current average value.

Implementations§

Source §

impl<const D: usize> CenteredState<D>

Source

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

Constructs a new CenteredState.

Source §

impl<const D: usize> CenteredState<D>

Source

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

Moves the state to a device.

§Arguments

device - Device to move the state to.

§Returns

self - Moved state.

Trait Implementations§

Source §

impl<const D: usize> Clone for CenteredState<D>

Source §

fn clone(&self) -> CenteredState<D>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<const D: usize> RecordState for CenteredState<D>

Source §

fn state_flatten(&self, prefix: &str, out: &mut StateSink)

Flatten self into out, naming every leaf under prefix.

Source §

fn state_unflatten( prefix: &str, src: &mut StateSource, device: &Device, ) -> Option<Self>

Rebuild a value from src, reading leaves named under prefix. Read more

Auto Trait Implementations§

§

impl<const D: usize> UnwindSafe for CenteredState<D>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> CloneExpand for T
where T: Clone,

Source §

fn __expand_clone_method(&self, _: &Scope) -> T

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

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

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

Source §

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> IntoComptime for T

Source §

fn comptime(self) -> Self

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 §