ChainedOptimizer

Struct ChainedOptimizer 

Source
pub struct ChainedOptimizer<A, D>{ /* private fields */ }
Expand description

A chained composition of optimizers

This wraps one optimizer with another, similar to how Lookahead wraps another optimizer. The inner optimizer is applied first, and then the outer optimizer is applied to the result.

§Example

use scirs2_core::ndarray::Array1;
use optirs_core::optimizer_composition::ChainedOptimizer;
use optirs_core::optimizers::{SGD, Adam, Optimizer};

// Create optimizers
let inner = SGD::new(0.1);
let outer = Adam::new(0.01);

// Chain them together
let mut chained_optimizer = ChainedOptimizer::new(Box::new(inner), Box::new(outer));

// Use the chained optimizer
let params = Array1::zeros(5);
let gradients = Array1::ones(5);
let updated_params = chained_optimizer.step(&params, &gradients).unwrap();

Implementations§

Source§

impl<A, D> ChainedOptimizer<A, D>

Source

pub fn new( inner: Box<dyn Optimizer<A, D>>, outer: Box<dyn Optimizer<A, D>>, ) -> Self

Create a new chained optimizer

§Arguments
  • inner - The inner optimizer, applied first
  • outer - The outer optimizer, applied to the result of the inner optimizer
Source

pub fn inner(&self) -> &dyn Optimizer<A, D>

Get a reference to the inner optimizer

Source

pub fn inner_mut(&mut self) -> &mut dyn Optimizer<A, D>

Get a mutable reference to the inner optimizer

Source

pub fn outer(&self) -> &dyn Optimizer<A, D>

Get a reference to the outer optimizer

Source

pub fn outer_mut(&mut self) -> &mut dyn Optimizer<A, D>

Get a mutable reference to the outer optimizer

Trait Implementations§

Source§

impl<A, D> Optimizer<A, D> for ChainedOptimizer<A, D>

Source§

fn step( &mut self, params: &Array<A, D>, gradients: &Array<A, D>, ) -> Result<Array<A, D>>

Updates parameters using the given gradients Read more
Source§

fn get_learning_rate(&self) -> A

Gets the current learning rate
Source§

fn set_learning_rate(&mut self, learningrate: A)

Sets a new learning rate
Source§

fn step_list( &mut self, params_list: &[&Array<A, D>], gradients_list: &[&Array<A, D>], ) -> Result<Vec<Array<A, D>>>

Updates multiple parameter arrays at once Read more

Auto Trait Implementations§

§

impl<A, D> Freeze for ChainedOptimizer<A, D>

§

impl<A, D> !RefUnwindSafe for ChainedOptimizer<A, D>

§

impl<A, D> !Send for ChainedOptimizer<A, D>

§

impl<A, D> !Sync for ChainedOptimizer<A, D>

§

impl<A, D> Unpin for ChainedOptimizer<A, D>

§

impl<A, D> !UnwindSafe for ChainedOptimizer<A, D>

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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