Remove stale step() docstring from DeepSpeedCPUAdam - #8011
Merged
tohtana merged 2 commits intoMay 19, 2026
Conversation
The constructor docstring described a step() option that "updates optimizer states and copies the parameters back to GPU at the same time" -- the old adam_update_copy kernel invoked via step(fp16_param_groups=...). That fused -copy path no longer exists: csrc/adam/cpu_adam.cpp binds only adam_update, and step()/step_subgroup() take no such argument. Drop the obsolete text. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: Lucas Pirola <lucas@pirola.eu>
tohtana
approved these changes
May 19, 2026
tohtana
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for updating the old doc, @lucaspirola!
tohtana
enabled auto-merge (squash)
May 19, 2026 17:02
frozenleaves
pushed a commit
to frozenleaves/DeepSpeed
that referenced
this pull request
Jun 8, 2026
## What Removes an obsolete paragraph from the `DeepSpeedCPUAdam` constructor docstring. ## Why The docstring described a `step()` option that "updates optimizer states and copies the parameters back to GPU at the same time" — the old `adam_update_copy` kernel, invoked via `step(fp16_param_groups=...)`. That fused-copy path no longer exists in the codebase: - `csrc/adam/cpu_adam.cpp` binds only `adam_update` (no `adam_update_copy`). - `DeepSpeedCPUAdam.step()` / `step_subgroup()` take no `fp16_param_groups` argument and only call `adam_update`. So the "two options" text is stale and misleading to anyone reading the API. Docstring-only change; no functional impact. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Signed-off-by: Lucas Pirola <lucas@pirola.eu> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
nathon-lee
pushed a commit
to nathon-lee/DeepSpeed_woo
that referenced
this pull request
Jul 1, 2026
## What Removes an obsolete paragraph from the `DeepSpeedCPUAdam` constructor docstring. ## Why The docstring described a `step()` option that "updates optimizer states and copies the parameters back to GPU at the same time" — the old `adam_update_copy` kernel, invoked via `step(fp16_param_groups=...)`. That fused-copy path no longer exists in the codebase: - `csrc/adam/cpu_adam.cpp` binds only `adam_update` (no `adam_update_copy`). - `DeepSpeedCPUAdam.step()` / `step_subgroup()` take no `fp16_param_groups` argument and only call `adam_update`. So the "two options" text is stale and misleading to anyone reading the API. Docstring-only change; no functional impact. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Signed-off-by: Lucas Pirola <lucas@pirola.eu> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: nathon-lee <leejianwoo@gmail.com>
nathon-lee
pushed a commit
to nathon-lee/DeepSpeed_woo
that referenced
this pull request
Jul 1, 2026
## What Removes an obsolete paragraph from the `DeepSpeedCPUAdam` constructor docstring. ## Why The docstring described a `step()` option that "updates optimizer states and copies the parameters back to GPU at the same time" — the old `adam_update_copy` kernel, invoked via `step(fp16_param_groups=...)`. That fused-copy path no longer exists in the codebase: - `csrc/adam/cpu_adam.cpp` binds only `adam_update` (no `adam_update_copy`). - `DeepSpeedCPUAdam.step()` / `step_subgroup()` take no `fp16_param_groups` argument and only call `adam_update`. So the "two options" text is stale and misleading to anyone reading the API. Docstring-only change; no functional impact. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Signed-off-by: Lucas Pirola <lucas@pirola.eu> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Removes an obsolete paragraph from the
DeepSpeedCPUAdamconstructor docstring.Why
The docstring described a
step()option that "updates optimizer states andcopies the parameters back to GPU at the same time" — the old
adam_update_copykernel, invoked via
step(fp16_param_groups=...). That fused-copy path no longerexists in the codebase:
csrc/adam/cpu_adam.cppbinds onlyadam_update(noadam_update_copy).DeepSpeedCPUAdam.step()/step_subgroup()take nofp16_param_groupsargument and only call
adam_update.So the "two options" text is stale and misleading to anyone reading the API.
Docstring-only change; no functional impact.
🤖 Generated with Claude Code