Skip to main content

SparseMask

Struct SparseMask 

Source
pub struct SparseMask {
    pub mask: Vec<bool>,
}
Expand description

Boolean pruning mask over a weight tensor.

true → weight is active (kept). false → weight is pruned (zeroed).

Fields§

§mask: Vec<bool>

Element-wise mask (same length as the weight tensor).

Implementations§

Source§

impl SparseMask

Source

pub fn all_active(n: usize) -> Self

Create a mask with all weights active (unpruned).

Source

pub fn all_pruned(n: usize) -> Self

Create a mask with all weights pruned.

Source

pub fn len(&self) -> usize

Number of elements in the mask.

Source

pub fn is_empty(&self) -> bool

Returns true if the mask covers an empty weight tensor.

Source

pub fn count_active(&self) -> usize

Number of active (non-pruned) weights.

Source

pub fn count_pruned(&self) -> usize

Number of pruned weights.

Source

pub fn sparsity(&self) -> f32

Fraction of weights that are pruned ∈ [0, 1].

Source

pub fn apply(&self, weights: &[f32]) -> Vec<f32>

Apply the mask to a weight slice: pruned weights become 0.

Returns a new Vec<f32> of the same length.

§Panics

Panics if weights.len() != self.len().

Source

pub fn apply_in_place(&self, weights: &mut [f32])

Apply the mask in-place: pruned weights become 0.

§Panics

Panics if weights.len() != self.len().

Source

pub fn and(&self, other: &Self) -> Self

Combine two masks with logical AND (both must be active to stay active).

§Panics

Panics if the masks have different lengths.

Source

pub fn or(&self, other: &Self) -> Self

Combine two masks with logical OR (at least one active → active).

§Panics

Panics if the masks have different lengths.

Trait Implementations§

Source§

impl Clone for SparseMask

Source§

fn clone(&self) -> SparseMask

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 Debug for SparseMask

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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.