torch.nn.utils.get_total_norm — PyTorch 2.7 documentation (original) (raw)
torch.nn.utils.get_total_norm(tensors, norm_type=2.0, error_if_nonfinite=False, foreach=None)[source]¶
Compute the norm of an iterable of tensors.
The norm is computed over the norms of the individual tensors, as if the norms of the individual tensors were concatenated into a single vector.
Parameters
- tensors (Iterable _[_Tensor] or Tensor) – an iterable of Tensors or a single Tensor that will be normalized
- norm_type (float) – type of the used p-norm. Can be
'inf'for infinity norm. - error_if_nonfinite (bool) – if True, an error is thrown if the total norm of
tensorsisnan,inf, or-inf. Default:False - foreach (bool) – use the faster foreach-based implementation. If
None, use the foreach implementation for CUDA and CPU native tensors and silently fall back to the slow implementation for other device types. Default:None
Returns
Total norm of the tensors (viewed as a single vector).
Return type