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(¶ms, &gradients).unwrap();Implementations§
Source§impl<A, D> ChainedOptimizer<A, D>
impl<A, D> ChainedOptimizer<A, D>
Sourcepub fn new(
inner: Box<dyn Optimizer<A, D>>,
outer: Box<dyn Optimizer<A, D>>,
) -> Self
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 firstouter- The outer optimizer, applied to the result of the inner optimizer
Trait Implementations§
Source§impl<A, D> Optimizer<A, D> for ChainedOptimizer<A, D>
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>>
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
fn get_learning_rate(&self) -> A
Gets the current learning rate
Source§fn set_learning_rate(&mut self, learningrate: A)
fn set_learning_rate(&mut self, learningrate: A)
Sets a new learning rate
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.