Skip to main content

GroupLasso

Struct GroupLasso 

Source
pub struct GroupLasso<A: Float + ScalarOperand + Debug> { /* private fields */ }
Expand description

Group Lasso regularizer for structured sparsity

The Group Lasso penalty encourages entire groups of parameters to be zero, rather than individual parameters (as in standard L1/Lasso). This is useful when parameters have a natural grouping structure (e.g., features belonging to the same category, filters in a convolutional layer).

Penalty: lambda * sum_g(w_g * ||params[group_g]||_2)

where w_g is the weight for group g and ||.||_2 is the L2 norm.

§Examples

use scirs2_core::ndarray::Array1;
use optirs_core::regularizers::{GroupLasso, Regularizer};

// Create a Group Lasso regularizer with two groups
let regularizer = GroupLasso::new(0.1_f64)
    .with_groups(vec![vec![0, 1, 2], vec![3, 4, 5]]);

let params = Array1::from_vec(vec![1.0, 2.0, 3.0, 0.0, 0.0, 0.0]);
let penalty = regularizer.penalty(&params).expect("penalty computation failed");

Implementations§

Source§

impl<A: Float + ScalarOperand + Debug> GroupLasso<A>

Source

pub fn new(lambda: A) -> Self

Create a new Group Lasso regularizer

§Arguments
  • lambda - Regularization strength (must be non-negative)
Source

pub fn with_groups(self, groups: Vec<Vec<usize>>) -> Self

Set the groups for the regularizer (builder pattern)

§Arguments
  • groups - A vector of index sets, where each inner vector contains the parameter indices belonging to that group
Source

pub fn with_group_weights(self, weights: Vec<A>) -> Self

Set per-group weights (builder pattern)

§Arguments
  • weights - A vector of weights, one per group. Must have the same length as the number of groups.
Source

pub fn auto_groups(self, param_size: usize, group_size: usize) -> Self

Automatically create equal-sized groups (builder pattern)

Partitions parameter indices [0, param_size) into groups of group_size. The last group may be smaller if param_size is not evenly divisible.

§Arguments
  • param_size - Total number of parameters
  • group_size - Number of parameters per group
Source

pub fn lambda(&self) -> A

Get the regularization strength

Source

pub fn groups(&self) -> &[Vec<usize>]

Get the groups

Source

pub fn num_groups(&self) -> usize

Get the number of groups

Trait Implementations§

Source§

impl<A: Clone + Float + ScalarOperand + Debug> Clone for GroupLasso<A>

Source§

fn clone(&self) -> GroupLasso<A>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<A: Debug + Float + ScalarOperand + Debug> Debug for GroupLasso<A>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<A, D> Regularizer<A, D> for GroupLasso<A>

Source§

fn apply(&self, params: &Array<A, D>, gradients: &mut Array<A, D>) -> Result<A>

Apply regularization to parameters and gradients Read more
Source§

fn penalty(&self, params: &Array<A, D>) -> Result<A>

Compute the regularization penalty value Read more

Auto Trait Implementations§

§

impl<A> Freeze for GroupLasso<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for GroupLasso<A>
where A: RefUnwindSafe,

§

impl<A> Send for GroupLasso<A>
where A: Send,

§

impl<A> Sync for GroupLasso<A>
where A: Sync,

§

impl<A> Unpin for GroupLasso<A>
where A: Unpin,

§

impl<A> UnsafeUnpin for GroupLasso<A>
where A: UnsafeUnpin,

§

impl<A> UnwindSafe for GroupLasso<A>
where A: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V