pub struct WeightedOptimizer<A, D>{ /* private fields */ }Expand description
A weighted composition of optimizers
Runs all optimizers on the same parameters/gradients and returns the weighted average of their outputs. This allows blending the behavior of multiple optimization strategies.
§Example
use scirs2_core::ndarray::Array1;
use optirs_core::optimizer_composition::WeightedOptimizer;
use optirs_core::optimizers::{SGD, Adam, Optimizer};
// Create a weighted combination of SGD and Adam
let mut weighted = WeightedOptimizer::new()
.add_optimizer(Box::new(SGD::new(0.1)), 0.7)
.add_optimizer(Box::new(Adam::new(0.01)), 0.3);
let params = Array1::zeros(3);
let gradients = Array1::ones(3);
let updated = weighted.step(¶ms, &gradients).expect("step failed");Implementations§
Source§impl<A, D> WeightedOptimizer<A, D>
impl<A, D> WeightedOptimizer<A, D>
Sourcepub fn add_optimizer(self, opt: Box<dyn Optimizer<A, D>>, weight: A) -> Self
pub fn add_optimizer(self, opt: Box<dyn Optimizer<A, D>>, weight: A) -> Self
Add an optimizer with a given weight (builder pattern)
§Arguments
opt- The optimizer to addweight- The weight for this optimizer
Sourcepub fn with_optimizers(self, opts: Vec<(Box<dyn Optimizer<A, D>>, A)>) -> Self
pub fn with_optimizers(self, opts: Vec<(Box<dyn Optimizer<A, D>>, A)>) -> Self
Add multiple optimizers at once (builder pattern)
§Arguments
opts- A vector of (optimizer, weight) pairs
Sourcepub fn normalize_weights(&mut self)
pub fn normalize_weights(&mut self)
Normalize weights so they sum to 1
Sourcepub fn num_optimizers(&self) -> usize
pub fn num_optimizers(&self) -> usize
Get the number of optimizers
Trait Implementations§
Source§impl<A, D> Default for WeightedOptimizer<A, D>
impl<A, D> Default for WeightedOptimizer<A, D>
Source§impl<A, D> Optimizer<A, D> for WeightedOptimizer<A, D>
impl<A, D> Optimizer<A, D> for WeightedOptimizer<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, learning_rate: A)
fn set_learning_rate(&mut self, learning_rate: A)
Sets a new learning rate
Auto Trait Implementations§
impl<A, D> Freeze for WeightedOptimizer<A, D>
impl<A, D> !RefUnwindSafe for WeightedOptimizer<A, D>
impl<A, D> !Send for WeightedOptimizer<A, D>
impl<A, D> !Sync for WeightedOptimizer<A, D>
impl<A, D> Unpin for WeightedOptimizer<A, D>where
A: Unpin,
impl<A, D> UnsafeUnpin for WeightedOptimizer<A, D>
impl<A, D> !UnwindSafe for WeightedOptimizer<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.