Struct OptimizerAdaptor

Source

pub struct OptimizerAdaptor<O, M, B>where
    O: SimpleOptimizer<B::InnerBackend>,
    M: AutodiffModule<B>,
    B: AutodiffBackend,
{ /* private fields */ }

Expand description

Wrapper struct that adapts any simple optimizer into an optimizer.

Implementations§

Source §

impl<O, M, B> OptimizerAdaptor<O, M, B>
where O: SimpleOptimizer<B::InnerBackend>, M: AutodiffModule, B: AutodiffBackend,

Source

pub fn with_grad_clipping(self, gradient_clipping: GradientClipping) -> Self

Sets the gradient clipping.

§Arguments

gradient_clipping - The gradient clipping.

§Returns

The optimizer.

Trait Implementations§

Source §

impl<O, M, B> Clone for OptimizerAdaptor<O, M, B>
where O: SimpleOptimizer<B::InnerBackend> + Clone, M: AutodiffModule + Clone, B: AutodiffBackend + Clone,

Source §

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<O, B, M> From<O> for OptimizerAdaptor<O, M, B>
where B: AutodiffBackend, M: AutodiffModule, O: SimpleOptimizer<B::InnerBackend>,

Source §

fn from(optim: O) -> Self

Converts to this type from the input type.

Source §

impl<O, B, M> Optimizer<M, B> for OptimizerAdaptor<O, M, B>
where B: AutodiffBackend, M: AutodiffModule, O: SimpleOptimizer<B::InnerBackend>,

Source §

type Record = HashMap<ParamId, AdaptorRecord<O, B>>

Optimizer associative type to be used when saving and loading the state.

Source §

fn step(&mut self, lr: LearningRate, module: M, grads: GradientsParams) -> M

Perform the optimizer step using the given learning rate and gradients. The updated module is returned.

Source §

fn to_record(&self) -> Self::Record

Get the current state of the optimizer as a record.

Source §

fn load_record(self, record: Self::Record) -> Self

Load the state of the optimizer as a record.

Auto Trait Implementations§

§

impl<O, M, B> Freeze for OptimizerAdaptor<O, M, B>
where O: Freeze,

§

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

§

impl<O, M, B> Send for OptimizerAdaptor<O, M, B>

§

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

§

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

§

impl<O, M, B> UnwindSafe for OptimizerAdaptor<O, M, B>
where O: UnwindSafe, M: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<0>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<1>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<2>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<3>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<4>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<5>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<6>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<7>: UnwindSafe, <O as SimpleOptimizer<::InnerBackend>>::State<8>: UnwindSafe,

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> 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> 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 §

impl<T> Pointable for T

Source §

const ALIGN: usize

The alignment of pointer.

Source §

type Init = T

The type for initializers.

Source §

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

Source §

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

Source §

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

Source §

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

Source §

impl<T> PolicyExt for T
where T: ?Sized,

Source §

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

Source §

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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 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>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

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

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Source §

Struct OptimizerAdaptorCopy item path

Implementations§

impl<O, M, B> OptimizerAdaptor<O, M, B>where O: SimpleOptimizer<B::InnerBackend>, M: AutodiffModule<B>, B: AutodiffBackend,

pub fn with_grad_clipping(self, gradient_clipping: GradientClipping) -> Self

§Arguments

§Returns

Trait Implementations§

impl<O, M, B> Clone for OptimizerAdaptor<O, M, B>where O: SimpleOptimizer<B::InnerBackend> + Clone, M: AutodiffModule<B> + Clone, B: AutodiffBackend + Clone,

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

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

impl<O, B, M> From<O> for OptimizerAdaptor<O, M, B>where B: AutodiffBackend, M: AutodiffModule<B>, O: SimpleOptimizer<B::InnerBackend>,

fn from(optim: O) -> Self

impl<O, B, M> Optimizer<M, B> for OptimizerAdaptor<O, M, B>where B: AutodiffBackend, M: AutodiffModule<B>, O: SimpleOptimizer<B::InnerBackend>,

type Record = HashMap<ParamId, AdaptorRecord<O, B>>

fn step(&mut self, lr: LearningRate, module: M, grads: GradientsParams) -> M

fn to_record(&self) -> Self::Record

fn load_record(self, record: Self::Record) -> Self

Auto Trait Implementations§

impl<O, M, B> Freeze for OptimizerAdaptor<O, M, B>where O: Freeze,

impl<O, M, B> Send for OptimizerAdaptor<O, M, B>

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> PolicyExt for Twhere T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>where T: Policy<B, E>, P: Policy<B, E>,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere 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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct OptimizerAdaptor

impl<O, M, B> OptimizerAdaptor<O, M, B>
where O: SimpleOptimizer<B::InnerBackend>, M: AutodiffModule<B>, B: AutodiffBackend,

impl<O, M, B> Clone for OptimizerAdaptor<O, M, B>
where O: SimpleOptimizer<B::InnerBackend> + Clone, M: AutodiffModule<B> + Clone, B: AutodiffBackend + Clone,

impl<O, B, M> From<O> for OptimizerAdaptor<O, M, B>
where B: AutodiffBackend, M: AutodiffModule<B>, O: SimpleOptimizer<B::InnerBackend>,

impl<O, B, M> Optimizer<M, B> for OptimizerAdaptor<O, M, B>
where B: AutodiffBackend, M: AutodiffModule<B>, O: SimpleOptimizer<B::InnerBackend>,

impl<O, M, B> Freeze for OptimizerAdaptor<O, M, B>
where O: Freeze,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

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

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