AdamBuilder

nncombinator::optimizer

Struct AdamBuilder 

Source 
pub struct AdamBuilder<U, D>
where
    U: UnitValue<U>,
    D: Device<U>,
{ /* private fields */ }
Expand description

Implementation of a builder to generate Adam optimizers

Implementations§

Source§

impl<U, D> AdamBuilder<U, D>
where U: UnitValue<U>, D: Device<U>,

Source

pub fn new(device: &D) -> AdamBuilder<U, D>

Create an instance of AdamBuilder with additional parameters other than the default values

§Arguments
  • device - device
Source

pub fn lr(self, lr: U) -> AdamBuilder<U, D>

Replaces the value of field lr in AdamBuilder with the passed value and returns it.

§Arguments
  • lr - Learning rate
Source

pub fn weight_decay(self, weight_decay: U) -> AdamBuilder<U, D>

Replaces the value of field weight_decay in AdamBuilder with the passed value and returns it.

§Arguments
  • weight_decay - Learning rate
Source

pub fn b1(self, b1: U) -> AdamBuilder<U, D>

Replaces the value of field b1 in AdamBuilder with the passed value and returns it.

§Arguments
  • b1 - b1
Source

pub fn b2(self, b2: U) -> AdamBuilder<U, D>

Replaces the value of field b2 in AdamBuilder with the passed value and returns it.

§Arguments
  • b2 - b2

Trait Implementations§

Source§

impl<U> OptimizerBuilder<U, DeviceCpu<U>> for AdamBuilder<U, DeviceCpu<U>>
where U: UnitValue<U>, Adam<U, DeviceCpu<U>>: Optimizer<U, DeviceCpu<U>>,

Source§

type Output = Adam<U, DeviceCpu<U>>

Source§

fn build(&self, size: usize) -> Result<Self::Output, OptimizerBuildError>

Create and return an optimizer Read more
Source§

impl<U> OptimizerBuilder<U, DeviceGpu<U>> for AdamBuilder<U, DeviceGpu<U>>
where U: UnitValue<U>, DeviceGpu<U>: Device<U>, Adam<U, DeviceGpu<U>>: Optimizer<U, DeviceGpu<U>>,

Source§

type Output = Adam<U, DeviceGpu<U>>

Source§

fn build(&self, size: usize) -> Result<Self::Output, OptimizerBuildError>

Create and return an optimizer Read more

Auto Trait Implementations§

§

impl<U, D> Freeze for AdamBuilder<U, D>
where U: Freeze, D: Freeze,

§

impl<U, D> RefUnwindSafe for AdamBuilder<U, D>
where U: RefUnwindSafe, D: RefUnwindSafe,

§

impl<U, D> Send for AdamBuilder<U, D>
where D: Send,

§

impl<U, D> Sync for AdamBuilder<U, D>
where D: Sync,

§

impl<U, D> Unpin for AdamBuilder<U, D>
where U: Unpin, D: Unpin,

§

impl<U, D> UnwindSafe for AdamBuilder<U, D>
where U: UnwindSafe, D: 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> 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> 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, 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.