pub struct ParallelOptimizer<A, D>{ /* private fields */ }Expand description
A parallel composition of optimizers
This applies different optimizers to different parameter groups. Each group of parameters is updated using its assigned optimizer.
§Example
use scirs2_core::ndarray::Array1;
use optirs_core::optimizer_composition::{ParallelOptimizer, ParameterGroup};
use optirs_core::optimizers::{SGD, Adam, Optimizer};
// Create optimizers
let sgd = SGD::new(0.1);
let adam = Adam::new(0.01);
// Create parameter groups
let params1 = Array1::zeros(3);
let params2 = Array1::zeros(5);
let group1 = ParameterGroup::new(params1, 0); // Use SGD
let group2 = ParameterGroup::new(params2, 1); // Use Adam
// Combine them in parallel
let mut parallel_optimizer = ParallelOptimizer::new(
vec![Box::new(sgd), Box::new(adam)],
vec![group1, group2],
);
// The step method will update all parameter groups using their assigned optimizers
// (In a real use case, you'd provide the corresponding gradients)Implementations§
Source§impl<A, D> ParallelOptimizer<A, D>
impl<A, D> ParallelOptimizer<A, D>
Sourcepub fn new(
optimizers: Vec<Box<dyn Optimizer<A, D>>>,
parameter_groups: Vec<ParameterGroup<A, D>>,
) -> Self
pub fn new( optimizers: Vec<Box<dyn Optimizer<A, D>>>, parameter_groups: Vec<ParameterGroup<A, D>>, ) -> Self
Create a new parallel optimizer
§Arguments
optimizers- List of optimizers to useparameter_groups- Groups of parameters with their assigned optimizer indices
Sourcepub fn add_optimizer(&mut self, optimizer: Box<dyn Optimizer<A, D>>) -> usize
pub fn add_optimizer(&mut self, optimizer: Box<dyn Optimizer<A, D>>) -> usize
Sourcepub fn add_parameter_group(
&mut self,
params: Array<A, D>,
optimizerindex: usize,
) -> Result<usize>
pub fn add_parameter_group( &mut self, params: Array<A, D>, optimizerindex: usize, ) -> Result<usize>
Sourcepub fn num_optimizers(&self) -> usize
pub fn num_optimizers(&self) -> usize
Get the number of optimizers
Sourcepub fn num_parameter_groups(&self) -> usize
pub fn num_parameter_groups(&self) -> usize
Get the number of parameter groups
Sourcepub fn get_optimizer(&self, index: usize) -> Option<&dyn Optimizer<A, D>>
pub fn get_optimizer(&self, index: usize) -> Option<&dyn Optimizer<A, D>>
Sourcepub fn get_optimizer_mut(
&mut self,
index: usize,
) -> Option<&mut dyn Optimizer<A, D>>
pub fn get_optimizer_mut( &mut self, index: usize, ) -> Option<&mut dyn Optimizer<A, D>>
Sourcepub fn get_parameter_group(&self, index: usize) -> Option<&ParameterGroup<A, D>>
pub fn get_parameter_group(&self, index: usize) -> Option<&ParameterGroup<A, D>>
Sourcepub fn get_parameter_group_mut(
&mut self,
index: usize,
) -> Option<&mut ParameterGroup<A, D>>
pub fn get_parameter_group_mut( &mut self, index: usize, ) -> Option<&mut ParameterGroup<A, D>>
Sourcepub fn get_all_parameters(&self) -> Result<Vec<Array<A, D>>>
pub fn get_all_parameters(&self) -> Result<Vec<Array<A, D>>>
Get all current parameter values as a single array
§Returns
A result containing all parameter values concatenated into a single array
Trait Implementations§
Source§impl<A, D> Optimizer<A, D> for ParallelOptimizer<A, D>
impl<A, D> Optimizer<A, D> for ParallelOptimizer<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 step_list(
&mut self,
params_list: &[&Array<A, D>],
gradients_list: &[&Array<A, D>],
) -> Result<Vec<Array<A, D>>>
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
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 ParallelOptimizer<A, D>
impl<A, D> !RefUnwindSafe for ParallelOptimizer<A, D>
impl<A, D> !Send for ParallelOptimizer<A, D>
impl<A, D> !Sync for ParallelOptimizer<A, D>
impl<A, D> Unpin for ParallelOptimizer<A, D>where
D: Unpin,
impl<A, D> !UnwindSafe for ParallelOptimizer<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.