Struct GradientClipper

Source

pub struct GradientClipper {
    pub last_norm: Option<f64>,
    pub was_clipped: bool,
    /* private fields */
}

Expand description

Gradient clipper to prevent exploding gradients

Provides various clipping strategies:

Norm clipping: Scales all gradients if total norm exceeds threshold
Value clipping: Clips individual gradient values to [-clip_value, clip_value]
Adaptive clipping: Clips based on parameter magnitude

Fields§

§last_norm: Option<f64>

Statistics about last clipping operation

§was_clipped: bool

Implementations§

Source §

impl GradientClipper

Source

pub fn by_norm(max_norm: f64) -> Self

Create clipper with norm-based strategy

Source

pub fn by_value(clip_value: f64) -> Self

Create clipper with value-based strategy

Source

pub fn adaptive(clip_factor: f64) -> Self

Create clipper with adaptive strategy

Source

pub fn clip(&mut self, params: &mut [TQParameter]) -> Result<()>

Clip gradients in place

Source

pub fn statistics(&self) -> ClippingStatistics

Get clipping statistics

Auto Trait Implementations§

§

impl UnwindSafe for GradientClipper

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §