pub struct NeuralOptimizer<F: Float + ScalarOperand> { /* private fields */ }
Expand description
Neural network optimizer that uses scirs2-optimize stochastic methods
Implementations§
Source§impl<F> NeuralOptimizer<F>
impl<F> NeuralOptimizer<F>
Sourcepub fn new(method: StochasticMethod, options: StochasticOptions) -> Self
pub fn new(method: StochasticMethod, options: StochasticOptions) -> Self
Create a new neural optimizer
Sourcepub fn adam(learning_rate: F, max_iter: usize) -> Self
pub fn adam(learning_rate: F, max_iter: usize) -> Self
Create Adam optimizer for neural networks
Sourcepub fn adamw(learning_rate: F, max_iter: usize) -> Self
pub fn adamw(learning_rate: F, max_iter: usize) -> Self
Create AdamW optimizer for neural networks
Sourcepub fn step(
&mut self,
params: &mut NeuralParameters<F>,
) -> Result<(), OptimizeError>
pub fn step( &mut self, params: &mut NeuralParameters<F>, ) -> Result<(), OptimizeError>
Update neural network parameters using the selected optimizer
Sourcepub fn get_learning_rate(&self) -> f64
pub fn get_learning_rate(&self) -> f64
Get current learning rate
Sourcepub fn set_learning_rate(&mut self, lr: f64)
pub fn set_learning_rate(&mut self, lr: f64)
Set learning rate
Sourcepub fn method_name(&self) -> &'static str
pub fn method_name(&self) -> &'static str
Get optimizer method name
Auto Trait Implementations§
impl<F> Freeze for NeuralOptimizer<F>
impl<F> RefUnwindSafe for NeuralOptimizer<F>where
F: RefUnwindSafe,
impl<F> Send for NeuralOptimizer<F>where
F: Send,
impl<F> Sync for NeuralOptimizer<F>where
F: Sync,
impl<F> Unpin for NeuralOptimizer<F>
impl<F> UnwindSafe for NeuralOptimizer<F>where
F: RefUnwindSafe,
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.