Skip to main content

Sgd

mlx_optim

Struct Sgd 

Source 
pub struct Sgd { /* private fields */ }
Expand description

Stochastic Gradient Descent with optional momentum.

Implementations§

Source§

impl Sgd

Source

pub fn new(lr: f32, momentum: f32) -> Self

Create a new SGD optimizer.

  • lr: learning rate
  • momentum: momentum factor (0.0 = no momentum)

Trait Implementations§

Source§

impl Optimizer for Sgd

Source§

fn step(&mut self, params: &[Tensor], grads: &[Tensor]) -> Result<Vec<Tensor>>

Auto Trait Implementations§

§

impl Freeze for Sgd

§

impl !RefUnwindSafe for Sgd

§

impl Send for Sgd

§

impl Sync for Sgd

§

impl Unpin for Sgd

§

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