mlx_rs::optimizers

Struct AdafactorBuilder

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

Builder for Adafactor.

Implementations§

Source§

impl AdafactorBuilder

Source

pub fn new() -> Self

Creates a new AdafactorBuilder.

Source§

impl AdafactorBuilder

Source

pub fn lr(self, lr: impl Into<Option<f32>>) -> Self

Sets the value of [lr].

Source

pub fn eps(self, eps: impl Into<AdafactorEps>) -> Self

Sets the value of [eps].

Source

pub fn clip_threshold(self, clip_threshold: impl Into<f32>) -> Self

Sets the value of [clip_threshold].

Source

pub fn decay_rate(self, decay_rate: impl Into<f32>) -> Self

Sets the value of [decay_rate].

Source

pub fn beta1(self, beta1: impl Into<AdafactorBuilderBeta1>) -> Self

Sets the value of [beta1].

Source

pub fn weight_decay(self, weight_decay: impl Into<f32>) -> Self

Sets the value of [weight_decay].

Source

pub fn scale_parameter(self, scale_parameter: impl Into<bool>) -> Self

Sets the value of [scale_parameter].

Source

pub fn relative_step(self, relative_step: impl Into<bool>) -> Self

Sets the value of [relative_step].

Source

pub fn warmup_init(self, warmup_init: impl Into<bool>) -> Self

Sets the value of [warmup_init].

Trait Implementations§

Source§

impl Builder<Adafactor> for AdafactorBuilder

Source§

type Error = AdafactorBuildError

Error with building
Source§

fn build(self) -> Result<Adafactor, Self::Error>

Build the type
Source§

impl Clone for AdafactorBuilder

Source§

fn clone(&self) -> AdafactorBuilder

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 Debug for AdafactorBuilder

Source§

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

Formats the value using the given formatter. Read more

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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

fn into_option(self) -> Option<T>

Convert into an Option.
Source§

impl<T> IntoStrideBy for T

Source§

fn stride_by(self, stride: i32) -> StrideBy<T>

Create a stride indexing operation.
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<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.