pub struct GradientMask<A: Float, D: Dimension> { /* private fields */ }Expand description
Gradient masking and freezing utilities
Allows selective gradient updates by masking certain parameters
Implementations§
Source§impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> GradientMask<A, D>
impl<A: Float + ScalarOperand + Debug, D: Dimension + Send + Sync> GradientMask<A, D>
Sourcepub fn freeze_all(shape: D) -> Self
pub fn freeze_all(shape: D) -> Self
Create a mask that freezes all parameters
Sourcepub fn update_all(shape: D) -> Self
pub fn update_all(shape: D) -> Self
Create a mask that updates all parameters
Sourcepub fn with_lr_multipliers(self, multipliers: Array<A, D>) -> Self
pub fn with_lr_multipliers(self, multipliers: Array<A, D>) -> Self
Set learning rate multipliers for different parameters
Sourcepub fn apply_mask<'a>(
&self,
gradients: &'a mut Array<A, D>,
) -> &'a mut Array<A, D>
pub fn apply_mask<'a>( &self, gradients: &'a mut Array<A, D>, ) -> &'a mut Array<A, D>
Sourcepub fn freeze_indices(&mut self, indices: &[usize]) -> Result<()>
pub fn freeze_indices(&mut self, indices: &[usize]) -> Result<()>
Freeze specific parameters by indices
Sourcepub fn unfreeze_indices(&mut self, indices: &[usize]) -> Result<()>
pub fn unfreeze_indices(&mut self, indices: &[usize]) -> Result<()>
Unfreeze specific parameters by indices
Sourcepub fn num_frozen(&self) -> usize
pub fn num_frozen(&self) -> usize
Get the number of frozen parameters
Sourcepub fn num_active(&self) -> usize
pub fn num_active(&self) -> usize
Get the number of active (unfrozen) parameters
Trait Implementations§
Auto Trait Implementations§
impl<A, D> Freeze for GradientMask<A, D>where
D: Freeze,
impl<A, D> RefUnwindSafe for GradientMask<A, D>where
D: RefUnwindSafe,
A: RefUnwindSafe,
impl<A, D> Send for GradientMask<A, D>where
A: Send,
impl<A, D> Sync for GradientMask<A, D>where
A: Sync,
impl<A, D> Unpin for GradientMask<A, D>where
D: Unpin,
impl<A, D> UnwindSafe for GradientMask<A, D>where
D: UnwindSafe,
A: 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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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.