RiemannianAdamConfig

Struct RiemannianAdamConfig 

Source
pub struct RiemannianAdamConfig<M, B> {
    pub lr: f64,
    pub beta1: f64,
    pub beta2: f64,
    pub eps: f64,
    pub weight_decay: f64,
    pub amsgrad: bool,
    pub stabilize: Option<usize>,
    /* private fields */
}
Expand description

Configuration for the Riemannian Adam optimizer.

This optimizer extends the Adam algorithm to work on Riemannian manifolds, following the approach described in “Riemannian adaptive optimization methods” (Bécigneul & Ganea, 2018).

§Example

use manopt_rs::prelude::*;

let config = RiemannianAdamConfig::<Euclidean, burn::backend::NdArray>::new()
    .with_lr(0.001)
    .with_beta1(0.9)
    .with_beta2(0.999)
    .with_eps(1e-8)
    .with_amsgrad(true);

Fields§

§lr: f64§beta1: f64§beta2: f64§eps: f64§weight_decay: f64§amsgrad: bool§stabilize: Option<usize>

Implementations§

Source§

impl<M, B> RiemannianAdamConfig<M, B>
where M: Manifold<B>, B: Backend,

Source

pub fn new() -> Self

Source

pub fn with_lr(self, lr: f64) -> Self

Source

pub fn with_beta1(self, beta1: f64) -> Self

Source

pub fn with_beta2(self, beta2: f64) -> Self

Source

pub fn with_eps(self, eps: f64) -> Self

Source

pub fn with_weight_decay(self, weight_decay: f64) -> Self

Source

pub fn with_amsgrad(self, amsgrad: bool) -> Self

Source

pub fn with_stabilize(self, stabilize: Option<usize>) -> Self

Source§

impl<M, B> RiemannianAdamConfig<M, B>
where M: Manifold<B>, B: Backend,

Source

pub fn init<Back: AutodiffBackend, Mod: AutodiffModule<Back>>( &self, ) -> OptimizerAdaptor<RiemannianAdam<M, Back::InnerBackend>, Mod, Back>
where M: Manifold<Back::InnerBackend>,

Trait Implementations§

Source§

impl<M: Clone, B: Clone> Clone for RiemannianAdamConfig<M, B>

Source§

fn clone(&self) -> RiemannianAdamConfig<M, B>

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<M: Debug, B: Debug> Debug for RiemannianAdamConfig<M, B>

Source§

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

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

impl<M, B> Default for RiemannianAdamConfig<M, B>
where M: Manifold<B>, B: Backend,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<M, B> Freeze for RiemannianAdamConfig<M, B>

§

impl<M, B> RefUnwindSafe for RiemannianAdamConfig<M, B>

§

impl<M, B> Send for RiemannianAdamConfig<M, B>
where M: Send, B: Send,

§

impl<M, B> Sync for RiemannianAdamConfig<M, B>
where M: Sync, B: Sync,

§

impl<M, B> Unpin for RiemannianAdamConfig<M, B>
where M: Unpin, B: Unpin,

§

impl<M, B> UnwindSafe for RiemannianAdamConfig<M, B>
where M: UnwindSafe, B: 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> 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> 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> 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.
Source§

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

Source§

fn vzip(self) -> V