Skip to content

docs(runtime): document max_norm and use_graph in clip_tensors_by_global_norm #8450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
simpleqt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(runtime): document max_norm and use_graph in clip_tensors_by_global_norm #8450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions deepspeed/runtime/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,9 +969,12 @@ def clip_tensors_by_global_norm(input_tensors, max_norm=1.0, global_norm=None, m
"""Clip list of tensors by global norm.
Args:
input_tensors: List of tensors to be clipped
max_norm (float, optional): Max norm used for clipping. Defaults to 1.0
global_norm (float, optional): Precomputed norm. Defaults to None.
mpu (optional): model parallelism unit. Defaults to None.
eps (float, optional): epsilon value added to grad norm. Defaults to 1e-6
use_graph (bool, optional): Whether to capture the norm computation in
a CUDA graph. Defaults to False
Returns:
float: the global norm
"""
Expand Down
Loading