Struct candle_nn::optim::SGD

source ·
pub struct SGD { /* private fields */ }
Expand description

Optimizer for Stochastic Gradient Descent.

Contrary to the PyTorch implementation of SGD, this version does not support momentum.

Implementations§

source§

impl SGD

source

pub fn into_inner(self) -> Vec<Var>

source

pub fn push(&mut self, var: &Var)

Trait Implementations§

source§

impl Debug for SGD

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Optimizer for SGD

§

type Config = f64

source§

fn new(vars: Vec<Var>, learning_rate: f64) -> Result<Self>

source§

fn learning_rate(&self) -> f64

source§

fn step(&mut self, grads: &GradStore) -> Result<()>

source§

fn set_learning_rate(&mut self, lr: f64)

source§

fn empty(config: Self::Config) -> Result<Self>

source§

fn backward_step(&mut self, loss: &Tensor) -> Result<()>

source§

fn from_slice(vars: &[&Var], config: Self::Config) -> Result<Self>

Auto Trait Implementations§

§

impl Freeze for SGD

§

impl !RefUnwindSafe for SGD

§

impl Send for SGD

§

impl Sync for SGD

§

impl Unpin for SGD

§

impl !UnwindSafe for SGD

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

source§

const ALIGN: usize = _

The alignment of pointer.
§

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

§

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

§

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

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

source§

fn vzip(self) -> V

source§

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