Struct GradientClipping

pub struct GradientClipping<F: Float + Debug + ScalarOperand + Display> {
    pub max_norm: F,
    pub method: GradientClippingMethod,
    pub log_stats: bool,
    /* private fields */
}

Gradient clipping callback

Fields

max_norm: F

Maximum norm for gradient clipping

method: GradientClippingMethod

Clipping method

log_stats: bool

Whether to log clipping statistics

Implementations

impl<F: Float + Debug + ScalarOperand + Display> GradientClipping<F>

pub fn by_global_norm(max_norm: F, log_stats: bool) -> Self

Create a new gradient clipping callback using global norm

pub fn by_value(max_value: F, log_stats: bool) -> Self

Create a new gradient clipping callback using value clipping

pub fn was_clipping_applied(&self) -> bool

Returns whether clipping was applied in the last step

pub fn get_clipping_ratio(&self) -> Option<F>

Returns the clipping ratio from the last step (if global norm method was used)

Trait Implementations

impl<F: Float + Debug + ScalarOperand + Display> Callback<F> for GradientClipping<F>

fn on_event( &mut self, timing: CallbackTiming, context: &mut CallbackContext<'_, F>, ) -> Result<()>

Called during training at specific points

impl<F: Debug + Float + Debug + ScalarOperand + Display> Debug for GradientClipping<F>

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

Formats the value using the given formatter.