tabensemb.model.AbstractNN.clip_gradients

method

AbstractNN.clip_gradients(optimizer: Optimizer, gradient_clip_val: int | float | None = None, gradient_clip_algorithm: str | None = None) → None

Handles gradient clipping internally.

Note

• Do not override this method. If you want to customize gradient clipping, consider using configure_gradient_clipping() method.

• For manual optimization (self.automatic_optimization = False), if you want to use gradient clipping, consider calling self.clip_gradients(opt, gradient_clip_val=0.5, gradient_clip_algorithm="norm") manually in the training step.

Parameters:

• optimizer – Current optimizer being used.

• gradient_clip_val – The value at which to clip gradients.

• gradient_clip_algorithm – The gradient clipping algorithm to use. Pass gradient_clip_algorithm="value" to clip by value, and gradient_clip_algorithm="norm" to clip by norm.