Skip to main content

GradientNoiseInjector

Struct GradientNoiseInjector 

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

Injects configurable noise into gradient arrays for training regularization.

Implementations§

Source§

impl GradientNoiseInjector

Source

pub fn new(config: GradientNoiseConfig) -> Self

Create a new injector from the given configuration.

The internal PRNG is seeded with config.seed (or a fallback value if the seed is zero, since xorshift64 requires a non-zero state).

Source

pub fn next_gaussian(&mut self) -> f64

Sample from a standard Gaussian (mean 0, std 1) using the Box-Muller transform.

Source

pub fn next_uniform(&mut self, low: f64, high: f64) -> f64

Sample from a uniform distribution on [low, high).

Source

pub fn next_laplacian(&mut self, scale: f64) -> f64

Sample from a Laplacian distribution with location 0 and the given scale, using the inverse-CDF method.

Source

pub fn clip_noise(&self, value: f64) -> f64

Clip value to [-clip, +clip] if a clip bound is configured, otherwise return value unchanged.

Source

pub fn current_scale(&self) -> f64

Compute the current effective noise scale, accounting for decay when using ScheduledGaussian.

Source

pub fn inject(&mut self, gradients: &mut [f64])

Inject noise into gradients in-place.

Each element of the slice receives an independent noise sample drawn from the configured distribution. Statistics are updated accordingly.

Source

pub fn sample_noise(&mut self, count: usize) -> NoiseSample

Generate count noise samples without applying them to any gradient array. Returns a NoiseSample with summary statistics.

Source

pub fn step(&mut self)

Advance the training step counter by one. This affects the noise scale when using ScheduledGaussian.

Source

pub fn reset(&mut self)

Reset the step counter, statistics, and re-seed the PRNG.

Source

pub fn stats(&self) -> &NoiseStats

Read-only access to the accumulated statistics.

Source

pub fn set_scale(&mut self, scale: f64)

Override the current noise scale (applies to all non-Scheduled types; for ScheduledGaussian this sets the initial scale used in decay).

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