Struct GradientClipper 

pub struct GradientClipper<T> { /* private fields */ }

Advanced gradient clipping system with adaptive scaling

Implementations

impl<T> GradientClipper<T>

where T: Float + FromPrimitive + Clone + Send + Sync + Default + 'static,

pub fn new(config: GradientClippingConfig) -> Self

Create a new gradient clipper with the specified configuration

pub fn default_stable() -> Self

Create a gradient clipper with default settings for stable training

pub fn default_adaptive() -> Self

Create a gradient clipper with adaptive scaling for dynamic adjustment

pub fn add_parameter_group(&mut self, group_name: String, threshold: f64)

Add a parameter group with its own clipping threshold

pub fn clip_gradients(&mut self, gradients: &mut [Tensor<T>]) -> Result<f64>

Clip gradients using global norm clipping

This is the main method for applying gradient clipping. It computes the global gradient norm across all tensors and scales them proportionally if needed.

pub fn clip_parameter_group( &mut self, group_name: &str, gradients: &mut [Tensor<T>], ) -> Result<f64>

Clip gradients for a specific parameter group

pub fn get_statistics(&self) -> &GradientStatistics

Get current gradient statistics

pub fn get_config(&self) -> &GradientClippingConfig

Get the current configuration

pub fn reset_statistics(&mut self)

Reset statistics (useful for training phase transitions)

pub fn get_clipping_rate(&self) -> f64

Get clipping rate (percentage of updates where clipping was applied)

pub fn would_clip(&self, gradients: &[Tensor<T>]) -> Result<bool>

Check if gradients would be clipped with current threshold