Struct TensorGradientClipper

Source

pub struct TensorGradientClipper {
    pub strategy: ClippingStrategy,
    pub stats: ClipperStats,
    pub ema_norm: f64,
}

Expand description

Applies gradient-clipping strategies to collections of GradientTensors.

Fields§

§strategy: ClippingStrategy

The clipping strategy in use.

§stats: ClipperStats

Cumulative statistics.

§ema_norm: f64

EMA of the global norm (used only by ClippingStrategy::Adaptive).

Implementations§

Source §

impl TensorGradientClipper

Source

pub fn new(strategy: ClippingStrategy) -> Self

Create a new clipper with the given strategy and zeroed statistics.

Source

pub fn clip(&mut self, tensors: &mut [GradientTensor]) -> Vec<ClippingResult>

Apply the configured clipping strategy to tensors in-place.

Returns one ClippingResult per input tensor.

Source

pub fn reset_stats(&mut self)

Reset all statistics and the EMA norm to their initial state.

Source

pub fn stats(&self) -> &ClipperStats

Return a reference to the current statistics.

Auto Trait Implementations§

§

impl UnwindSafe for TensorGradientClipper

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