Enum burn::optim::record::AdaptorRecordV1

pub enum AdaptorRecordV1<O, B>
where
    O: SimpleOptimizer<B>,
    B: Backend,
{
    Rank0(<O as SimpleOptimizer<B>>::State<0>),
    Rank1(<O as SimpleOptimizer<B>>::State<1>),
    Rank2(<O as SimpleOptimizer<B>>::State<2>),
    Rank3(<O as SimpleOptimizer<B>>::State<3>),
    Rank4(<O as SimpleOptimizer<B>>::State<4>),
    Rank5(<O as SimpleOptimizer<B>>::State<5>),
    Rank6(<O as SimpleOptimizer<B>>::State<6>),
    Rank7(<O as SimpleOptimizer<B>>::State<7>),
    Rank8(<O as SimpleOptimizer<B>>::State<8>),
}
Expand description

Optimizer adaptor record item.

Variants§

§

Rank0(<O as SimpleOptimizer<B>>::State<0>)

Rank 0.

§

Rank1(<O as SimpleOptimizer<B>>::State<1>)

Rank 1.

§

Rank2(<O as SimpleOptimizer<B>>::State<2>)

Rank 2.

§

Rank3(<O as SimpleOptimizer<B>>::State<3>)

Rank 3.

§

Rank4(<O as SimpleOptimizer<B>>::State<4>)

Rank 4.

§

Rank5(<O as SimpleOptimizer<B>>::State<5>)

Rank 5.

§

Rank6(<O as SimpleOptimizer<B>>::State<6>)

Rank 6.

§

Rank7(<O as SimpleOptimizer<B>>::State<7>)

Rank 7.

§

Rank8(<O as SimpleOptimizer<B>>::State<8>)

Rank 8.

Implementations§

§

impl<O, B> AdaptorRecordV1<O, B>
where O: SimpleOptimizer<B>, B: Backend,

pub fn into_state<const D: usize>(self) -> <O as SimpleOptimizer<B>>::State<D>

Convert the record into the state.

§Returns

The state.

§Panics

Panics if the state dimension is not supported.

pub fn from_state<const D: usize>( state: <O as SimpleOptimizer<B>>::State<D>, ) -> AdaptorRecordV1<O, B>

Convert the state into the record.

§Arguments
  • state: The state.
§Returns

The record.

Trait Implementations§

§

impl<O, B> Clone for AdaptorRecordV1<O, B>
where O: SimpleOptimizer<B>, B: Backend,

§

fn clone(&self) -> AdaptorRecordV1<O, B>

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<O, B> Record<B> for AdaptorRecordV1<O, B>
where O: SimpleOptimizer<B>, B: Backend,

§

type Item<S: PrecisionSettings> = AdaptorRecordItemV1<O, B, S>

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

fn into_item<S>(self) -> <AdaptorRecordV1<O, B> 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: <AdaptorRecordV1<O, B> as Record<B>>::Item<S>, device: &<B as Backend>::Device, ) -> AdaptorRecordV1<O, B>
where S: PrecisionSettings,

Convert the given item into a record.

Auto Trait Implementations§

§

impl<O, B> Freeze for AdaptorRecordV1<O, B>
where <O as SimpleOptimizer<B>>::State<0>: Freeze, <O as SimpleOptimizer<B>>::State<1>: Freeze, <O as SimpleOptimizer<B>>::State<2>: Freeze, <O as SimpleOptimizer<B>>::State<3>: Freeze, <O as SimpleOptimizer<B>>::State<4>: Freeze, <O as SimpleOptimizer<B>>::State<5>: Freeze, <O as SimpleOptimizer<B>>::State<6>: Freeze, <O as SimpleOptimizer<B>>::State<7>: Freeze, <O as SimpleOptimizer<B>>::State<8>: Freeze,

§

impl<O, B> RefUnwindSafe for AdaptorRecordV1<O, B>
where <O as SimpleOptimizer<B>>::State<0>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<1>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<2>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<3>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<4>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<5>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<6>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<7>: RefUnwindSafe, <O as SimpleOptimizer<B>>::State<8>: RefUnwindSafe,

§

impl<O, B> Send for AdaptorRecordV1<O, B>

§

impl<O, B> Sync for AdaptorRecordV1<O, B>
where <O as SimpleOptimizer<B>>::State<0>: Sync, <O as SimpleOptimizer<B>>::State<1>: Sync, <O as SimpleOptimizer<B>>::State<2>: Sync, <O as SimpleOptimizer<B>>::State<3>: Sync, <O as SimpleOptimizer<B>>::State<4>: Sync, <O as SimpleOptimizer<B>>::State<5>: Sync, <O as SimpleOptimizer<B>>::State<6>: Sync, <O as SimpleOptimizer<B>>::State<7>: Sync, <O as SimpleOptimizer<B>>::State<8>: Sync,

§

impl<O, B> Unpin for AdaptorRecordV1<O, B>
where <O as SimpleOptimizer<B>>::State<0>: Unpin, <O as SimpleOptimizer<B>>::State<1>: Unpin, <O as SimpleOptimizer<B>>::State<2>: Unpin, <O as SimpleOptimizer<B>>::State<3>: Unpin, <O as SimpleOptimizer<B>>::State<4>: Unpin, <O as SimpleOptimizer<B>>::State<5>: Unpin, <O as SimpleOptimizer<B>>::State<6>: Unpin, <O as SimpleOptimizer<B>>::State<7>: Unpin, <O as SimpleOptimizer<B>>::State<8>: Unpin,

§

impl<O, B> UnwindSafe for AdaptorRecordV1<O, B>
where <O as SimpleOptimizer<B>>::State<0>: UnwindSafe, <O as SimpleOptimizer<B>>::State<1>: UnwindSafe, <O as SimpleOptimizer<B>>::State<2>: UnwindSafe, <O as SimpleOptimizer<B>>::State<3>: UnwindSafe, <O as SimpleOptimizer<B>>::State<4>: UnwindSafe, <O as SimpleOptimizer<B>>::State<5>: UnwindSafe, <O as SimpleOptimizer<B>>::State<6>: UnwindSafe, <O as SimpleOptimizer<B>>::State<7>: UnwindSafe, <O as SimpleOptimizer<B>>::State<8>: 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,