Skip to main content

SquareAvgState

burn::optim

Struct SquareAvgState 

Source 
pub struct SquareAvgState<B, const D: usize>
where
    B: Backend,
{
    pub square_avg: Tensor<B, D>,
}
Expand description

SquareAvgState is to store and pass optimizer step params.

Fields§

§square_avg: Tensor<B, D>

Current squared average.

Implementations§

Source§

impl<B, const D: usize> SquareAvgState<B, D>
where B: Backend,

Source

pub fn new(square_avg: Tensor<B, D>) -> SquareAvgState<B, D>

Constructs a new SquareAvgState.

Source§

impl<B, const D: usize> SquareAvgState<B, D>
where B: Backend,

Source

pub fn to_device( self, device: &<B as BackendTypes>::Device, ) -> SquareAvgState<B, D>

Moves the state to a device.

§Arguments
  • device - Device to move the state to.
§Returns
  • self - Moved state.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> SquareAvgState<B, 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<B, const D: usize> Record<B> for SquareAvgState<B, D>
where B: Backend,

Source§

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

Type of the item that can be serialized and deserialized.
Source§

fn into_item<S>(self) -> <SquareAvgState<B, D> as Record<B>>::Item<S>
where S: PrecisionSettings,

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

fn from_item<S>( item: <SquareAvgState<B, D> as Record<B>>::Item<S>, device: &<B as BackendTypes>::Device, ) -> SquareAvgState<B, D>
where S: PrecisionSettings,

Convert the given item into a record.

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.