Skip to content

fix test compatibility as AdamW became subclass of Adam #20574

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

Merged
merged 1 commit into from
Feb 26, 2025

Conversation

haifeng-jin
Copy link
Contributor

@haifeng-jin haifeng-jin commented Feb 5, 2025

What does this PR do?

As pytorch/pytorch#143710 got merged, which made AdamW a subclass of Adam, the test test_multiple_optimizers_basefinetuning fails as it adds more param_groups to the AdamW in addition to Adam.

This PR fixes the test by enforcing a strict check on the type of the optimizer to be exactly Adam not its subclasses.

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--20574.org.readthedocs.build/en/20574/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Feb 5, 2025
@haifeng-jin haifeng-jin changed the title fix forward compatibility as AdamW became subclass of Adam fix test compatibility as AdamW became subclass of Adam Feb 5, 2025
@Borda
Copy link
Member

Borda commented Feb 7, 2025

so this is for PT 2.6+ correct?

Copy link

codecov bot commented Feb 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79%. Comparing base (ea59e40) to head (d68b2dc).
Report is 6 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (ea59e40) and HEAD (d68b2dc). Click for more details.

HEAD has 2247 uploads less than BASE
Flag BASE (ea59e40) HEAD (d68b2dc)
cpu 525 24
lightning_fabric 67 0
pytest 266 0
python3.9 132 6
lightning 394 18
python3.10 66 3
python3.11 132 6
python3.12.7 195 9
gpu 2 0
pytorch2.1 99 9
pytest-full 261 24
pytorch2.2.2 33 3
pytorch_lightning 66 6
pytorch2.3 33 3
pytorch2.4.1 31 3
pytorch2.5.1 65 6
Additional details and impacted files
@@            Coverage Diff            @@
##           master   #20574     +/-   ##
=========================================
- Coverage      88%      79%     -9%     
=========================================
  Files         267      264      -3     
  Lines       23380    23325     -55     
=========================================
- Hits        20481    18366   -2115     
- Misses       2899     4959   +2060     

@haifeng-jin
Copy link
Contributor Author

No, PyTorch 2.6 did not include the commit.
We use the viable/strict branch, which is ahead of PyTorch 2.6.

Copy link
Collaborator

@lantiga lantiga left a comment

Choose a reason for hiding this comment

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

This is looking at post-2.6 but it's good with the current releases

@haifeng-jin
Copy link
Contributor Author

Hi @lantiga , is there a next-step for me to get this PR merged? Thanks!

@Borda Borda merged commit 9ef355b into Lightning-AI:master Feb 26, 2025
38 checks passed
Borda pushed a commit that referenced this pull request Mar 12, 2025
lexierule pushed a commit that referenced this pull request Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants