Mention GPA-AdamW in top-level README#259
Closed
hjmshi wants to merge 4 commits into
Closed
Conversation
…oad the correct commit data. Differential Revision: D101275252
…oad the correct commit data. Differential Revision: D103081868
…oad the correct commit data. Differential Revision: D103082000
Summary: The top-level `optimizers/README.md` (both internal `fbcode/hpc/optimizers/README.md` and OSS mirror `fbcode/ai_codesign/optimizers/README.md`) currently only lists Distributed Shampoo, but the GPA-AdamW optimizer was added under `gpa/` and is shipped to the OSS mirror by `oss_sync.sh`. This adds GPA-AdamW to: 1. The "Currently includes the optimizers" bullet list. 2. A new `### GPA-AdamW` subsection under Usage with a minimal `GPAAdamW(...)` instantiation example, plus a pointer to the full `gpa/README.md` for Schedule-Free vs GPA mode, hyperparameter tuning, and distributed training notes. 3. A small refactor of the Installation section to drop the `distributed_shampoo`-specific phrasing and link both example directories. The two READMEs are kept in sync manually (the OSS sync script does not copy `optimizers/README.md`), so both files receive identical edits. Differential Revision: D103703525
meta-cla
Bot
added
the
CLA Signed
|
@hjmshi has exported this pull request. If you are a Meta employee, you can view the originating Diff in D103703525. |
wz337
approved these changes
May 5, 2026
wz337
left a comment
wz337
left a comment
Contributor
There was a problem hiding this comment.
Review automatically exported from Phabricator review in Meta.
|
This pull request has been merged in 63d910c. |
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.
Summary:
The top-level
optimizers/README.md(both internalfbcode/hpc/optimizers/README.mdand OSS mirrorfbcode/ai_codesign/optimizers/README.md) currently only lists Distributed Shampoo, but the GPA-AdamW optimizer was added undergpa/and is shipped to the OSS mirror byoss_sync.sh. This adds GPA-AdamW to:### GPA-AdamWsubsection under Usage with a minimalGPAAdamW(...)instantiation example, plus a pointer to the fullgpa/README.mdfor Schedule-Free vs GPA mode, hyperparameter tuning, and distributed training notes.distributed_shampoo-specific phrasing and link both example directories.The two READMEs are kept in sync manually (the OSS sync script does not copy
optimizers/README.md), so both files receive identical edits.Differential Revision: D103703525