Struct burn::optim::SgdState

pub struct SgdState<B, const D: usize>
where
    B: Backend,
{ /* private fields */ }
Expand description

State of Sgd.

Implementations§

§

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

pub fn new(momentum: Option<MomentumState<B, D>>) -> SgdState<B, D>

Constructs a new SgdState.

Trait Implementations§

§

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

§

fn clone(&self) -> SgdState<B, D>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

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

§

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

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

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

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

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

Convert the given item into a record.

Auto Trait Implementations§

§

impl<B, const D: usize> Freeze for SgdState<B, D>
where <B as Backend>::FloatTensorPrimitive: Freeze, <B as Backend>::QuantizedTensorPrimitive: Freeze,

§

impl<B, const D: usize> RefUnwindSafe for SgdState<B, D>
where <B as Backend>::FloatTensorPrimitive: RefUnwindSafe, <B as Backend>::QuantizedTensorPrimitive: RefUnwindSafe,

§

impl<B, const D: usize> Send for SgdState<B, D>

§

impl<B, const D: usize> Sync for SgdState<B, D>

§

impl<B, const D: usize> Unpin for SgdState<B, D>
where <B as Backend>::FloatTensorPrimitive: Unpin, <B as Backend>::QuantizedTensorPrimitive: Unpin,

§

impl<B, const D: usize> UnwindSafe for SgdState<B, D>
where <B as Backend>::FloatTensorPrimitive: UnwindSafe, <B as Backend>::QuantizedTensorPrimitive: UnwindSafe,

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.
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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

source§

type Output = T

Should always be Self
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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,