pub struct ParameterGroup<A: Float, D: Dimension> {
pub id: usize,
pub params: Vec<Array<A, D>>,
pub config: ParameterGroupConfig<A>,
pub state: HashMap<String, Vec<Array<A, D>>>,
}Expand description
A parameter group with its own configuration
Fields§
§id: usizeUnique identifier for this group
params: Vec<Array<A, D>>Parameters in this group
config: ParameterGroupConfig<A>Configuration for this group
state: HashMap<String, Vec<Array<A, D>>>Internal state for optimization (optimizer-specific)
Implementations§
Source§impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> ParameterGroup<A, D>
impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> ParameterGroup<A, D>
Sourcepub fn new(
id: usize,
params: Vec<Array<A, D>>,
config: ParameterGroupConfig<A>,
) -> Self
pub fn new( id: usize, params: Vec<Array<A, D>>, config: ParameterGroupConfig<A>, ) -> Self
Create a new parameter group
Sourcepub fn num_params(&self) -> usize
pub fn num_params(&self) -> usize
Get the number of parameters in this group
Sourcepub fn learning_rate(&self, default: A) -> A
pub fn learning_rate(&self, default: A) -> A
Get learning rate for this group
Sourcepub fn weight_decay(&self, default: A) -> A
pub fn weight_decay(&self, default: A) -> A
Get weight decay for this group
Sourcepub fn get_custom_param(&self, key: &str, default: A) -> A
pub fn get_custom_param(&self, key: &str, default: A) -> A
Get custom parameter
Sourcepub fn apply_constraints(&mut self) -> Result<()>
pub fn apply_constraints(&mut self) -> Result<()>
Apply constraints to all parameters in this group
Sourcepub fn apply_constraints_to_param(&self, param: &mut Array<A, D>) -> Result<()>
pub fn apply_constraints_to_param(&self, param: &mut Array<A, D>) -> Result<()>
Apply constraints to a specific parameter
Sourcepub fn constraints(&self) -> &[ParameterConstraint<A>]
pub fn constraints(&self) -> &[ParameterConstraint<A>]
Get the constraints for this group
Trait Implementations§
Auto Trait Implementations§
impl<A, D> Freeze for ParameterGroup<A, D>where
A: Freeze,
impl<A, D> RefUnwindSafe for ParameterGroup<A, D>where
A: RefUnwindSafe,
D: RefUnwindSafe,
impl<A, D> Send for ParameterGroup<A, D>where
A: Send,
impl<A, D> Sync for ParameterGroup<A, D>where
A: Sync,
impl<A, D> Unpin for ParameterGroup<A, D>
impl<A, D> UnwindSafe for ParameterGroup<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.