pub struct StructuredSparsity<A: Float + ScalarOperand + Debug> { /* private fields */ }Expand description
Structured sparsity regularizer
Applies Group Lasso regularization with groups defined by a structural pattern (columns, rows, or blocks). This is useful for encouraging structured sparsity in weight matrices, e.g., pruning entire neurons (row sparsity) or features (column sparsity).
§Examples
use scirs2_core::ndarray::Array1;
use optirs_core::regularizers::{StructuredSparsity, SparsityPattern, Regularizer};
// Create column-wise structured sparsity for a 3x4 matrix (stored as 12-element vector)
let regularizer = StructuredSparsity::new(0.1_f64, SparsityPattern::Column { num_columns: 4 });
let params = Array1::from_vec(vec![1.0, 0.0, 3.0, 0.0, 5.0, 0.0, 7.0, 0.0, 9.0, 0.0, 11.0, 0.0]);
let penalty = regularizer.penalty(¶ms).expect("penalty computation failed");Implementations§
Source§impl<A: Float + ScalarOperand + Debug> StructuredSparsity<A>
impl<A: Float + ScalarOperand + Debug> StructuredSparsity<A>
Sourcepub fn new(lambda: A, pattern: SparsityPattern) -> Self
pub fn new(lambda: A, pattern: SparsityPattern) -> Self
Create a new structured sparsity regularizer
§Arguments
lambda- Regularization strengthpattern- The structural pattern defining how parameters are grouped
Sourcepub fn pattern(&self) -> &SparsityPattern
pub fn pattern(&self) -> &SparsityPattern
Get the sparsity pattern
Trait Implementations§
Source§impl<A: Clone + Float + ScalarOperand + Debug> Clone for StructuredSparsity<A>
impl<A: Clone + Float + ScalarOperand + Debug> Clone for StructuredSparsity<A>
Source§fn clone(&self) -> StructuredSparsity<A>
fn clone(&self) -> StructuredSparsity<A>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<A: Debug + Float + ScalarOperand + Debug> Debug for StructuredSparsity<A>
impl<A: Debug + Float + ScalarOperand + Debug> Debug for StructuredSparsity<A>
Source§impl<A, D> Regularizer<A, D> for StructuredSparsity<A>
impl<A, D> Regularizer<A, D> for StructuredSparsity<A>
Auto Trait Implementations§
impl<A> Freeze for StructuredSparsity<A>where
A: Freeze,
impl<A> RefUnwindSafe for StructuredSparsity<A>where
A: RefUnwindSafe,
impl<A> Send for StructuredSparsity<A>where
A: Send,
impl<A> Sync for StructuredSparsity<A>where
A: Sync,
impl<A> Unpin for StructuredSparsity<A>where
A: Unpin,
impl<A> UnsafeUnpin for StructuredSparsity<A>where
A: UnsafeUnpin,
impl<A> UnwindSafe for StructuredSparsity<A>where
A: UnwindSafe,
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.