Skip to content

docs: fix Adam paper link and correct grammatical error in fused_adam.py #7294

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.

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
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions deepspeed/ops/adam/fused_adam.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class FusedAdam(torch.optim.Optimizer):
A previous version of :class:`FusedAdam` allowed a number of additional arguments to ``step``. These additional arguments
are now deprecated and unnecessary.

Adam was been proposed in `Adam: A Method for Stochastic Optimization`_.
Adam was proposed in `Adam: A Method for Stochastic Optimization`_.

Arguments:
params (iterable): iterable of parameters to optimize or dicts defining
Expand All @@ -67,7 +67,7 @@ class FusedAdam(torch.optim.Optimizer):
set_grad_none (bool, optional): whether set grad to None when zero_grad()
method is called. (default: True)

.. _Adam - A Method for Stochastic Optimization:
.. _Adam: A Method for Stochastic Optimization:
Copy link
Collaborator

@loadams loadams May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ishanjmukherjee Will this work properly with the docs given the : at the end of the title of this paper?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ishanjmukherjee - another tag on this, thoughts on the impact of the colon here?

https://arxiv.org/abs/1412.6980
.. _On the Convergence of Adam and Beyond:
https://openreview.net/forum?id=ryQu7f-RZ
Expand Down