Skip to main content

ModelPruner

Struct ModelPruner 

Source
pub struct ModelPruner { /* private fields */ }
Expand description

Stateful weight pruner. Advance the step counter with ModelPruner::advance_step between training iterations.

Implementations§

Source§

impl ModelPruner

Source

pub fn new(config: PrunerConfig) -> Self

Create a new pruner from the supplied configuration.

The PRNG seed is initialised to config.seed, falling back to 1 if the seed is zero (xorshift64 must not start from zero).

Source

pub fn prune_layer(&mut self, layer: &mut LayerWeights) -> PruningResult

Prune a single layer in-place according to the configured strategy.

The layer.weights vector is mutated directly; the mask (if enabled) is created or updated.

Source

pub fn prune_all(&mut self, layers: &mut [LayerWeights]) -> Vec<PruningResult>

Prune every layer in layers and return one result per layer.

Source

pub fn current_sparsity_target(&self) -> f64

Compute the sparsity target for the current step.

For PruningStrategy::GradualPruning this linearly interpolates between initial_sparsity and final_sparsity. For all other strategies it returns the equivalent fixed fraction.

Source

pub fn compute_threshold(weights: &[f64], percentile: f64) -> f64

Return the weight value at the given percentile (0–100) of the absolute-magnitude distribution.

Uses a partial sort to avoid allocating a fully sorted copy when only the boundary value is needed. Returns 0.0 for empty slices.

Source

pub fn compute_sparsity(weights: &[f64]) -> f64

Fraction of elements in weights that are exactly zero.

Source

pub fn compute_l1_norm(weights: &[f64]) -> f64

Sum of absolute values of weights.

Source

pub fn advance_step(&mut self)

Advance the step counter by one.

Source

pub fn next_uniform_prng(&mut self) -> f64

Generate the next pseudo-random float in [0, 1) using xorshift64.

The internal state is updated in-place so successive calls yield independent values.

Source

pub fn apply_mask(layer: &mut LayerWeights)

Zero out entries in layer.weights where the corresponding mask entry is false. If no mask is present this is a no-op.

Source

pub fn stats(&self) -> &PrunerStats

Immutable access to the accumulated statistics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more