Skip to main content

GradAdaptor

burn_optim::adaptor

Enum GradAdaptor 

Source 
pub enum GradAdaptor {
    Single(GradientsParams),
    Multi(MultiGradientsParams),
}
Expand description

Wrapper to unify the remove method for GradientsParams and MultiGradientsParams.

Variants§

§

Single(GradientsParams)

Wrapper for GradientsParams.

§

Multi(MultiGradientsParams)

Wrapper for MultiGradientsParams.

Implementations§

Source§

impl GradAdaptor

Source

pub fn remove<B: Backend, const D: usize>( &mut self, id: ParamId, ) -> Option<(Tensor<B, D>, Device<B>)>

Remove a gradient parameter by ID.

§Returns

Maybe the (tensor, device) pair.

Trait Implementations§

Source§

impl From<GradientsParams> for GradAdaptor

Source§

fn from(grads: GradientsParams) -> Self

Converts to this type from the input type.
Source§

impl From<MultiGradientsParams> for GradAdaptor

Source§

fn from(grads: MultiGradientsParams) -> Self

Converts to this type from the input type.

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> 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, 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.