Skip to main content

NaturalGradient

Struct NaturalGradient 

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

Natural Gradient optimizer

Natural gradients use the Fisher Information Matrix to precondition gradients, providing better-conditioned updates especially for neural networks and probabilistic models.

Reference: “Natural Gradient Works Efficiently in Learning” (Amari, 1998)

Implementations§

Source§

impl NaturalGradient

Source

pub fn new( params: Vec<Arc<RwLock<Tensor>>>, lr: Option<f32>, momentum: Option<f32>, damping: Option<f32>, fisher_update_freq: Option<usize>, use_empirical_fisher: Option<bool>, fisher_ema_decay: Option<f32>, ) -> Self

Create a new Natural Gradient optimizer

Source

pub fn builder() -> NaturalGradientBuilder

Builder pattern for Natural Gradient optimizer

Trait Implementations§

Source§

impl Optimizer for NaturalGradient

Source§

fn step(&mut self) -> OptimizerResult<()>

Perform a single optimization step
Source§

fn zero_grad(&mut self)

Zero all gradients
Source§

fn get_lr(&self) -> Vec<f32>

Get the current learning rate
Source§

fn set_lr(&mut self, lr: f32)

Set one learning rate for every parameter group (broadcast).
Source§

fn set_lrs(&mut self, lrs: &[f32])

Set the learning rate of each parameter group individually. Read more
Source§

fn add_param_group( &mut self, params: Vec<Arc<RwLock<Tensor>>>, options: HashMap<String, f32>, )

Add a parameter group
Source§

fn parameters(&self) -> Vec<Arc<RwLock<Tensor>>>

Get the parameter tensors managed by this optimizer. Read more
Source§

fn state_dict(&self) -> OptimizerResult<OptimizerState>

Get state dict for serialization
Source§

fn load_state_dict(&mut self, state: OptimizerState) -> OptimizerResult<()>

Load state dict

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<O> OptimizerExt for O
where O: Optimizer,

Source§

fn distributed( self, config: DistributedConfig, ) -> OptimizerResult<DistributedOptimizer<Self>>

Wrap this optimizer with distributed functionality
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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