Skip to content
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

Fix moving keys to device in ResultCollection #19814

Merged

Conversation

clumsy
Copy link
Contributor

@clumsy clumsy commented Apr 25, 2024

What does this PR do?

Move registered results' keys to the current device. Otherwise internal tensors like cumulated_batch_size will stay on cpu after they are moved there in previous call to teardown().

Removing standalone register_key() method because it's not used outside of this module and we either end up calling .to() twice or might need to require the potential users to call it themselves.

Fixes #19813

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--19814.org.readthedocs.build/en/19814/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Apr 25, 2024
@clumsy clumsy force-pushed the fix/move_existing_keys_to_device branch from 99dcf93 to 3db5c52 Compare April 25, 2024 16:26
@clumsy clumsy requested a review from Borda as a code owner April 25, 2024 16:26
@clumsy
Copy link
Contributor Author

clumsy commented Apr 25, 2024

Please check if you have a chance, @awaelchli

@clumsy clumsy force-pushed the fix/move_existing_keys_to_device branch from 3db5c52 to 8085e74 Compare April 25, 2024 21:50
@clumsy
Copy link
Contributor Author

clumsy commented May 28, 2024

Could you please check this bug, @Borda?

@clumsy
Copy link
Contributor Author

clumsy commented Jul 15, 2024

I would appreciate if you can check this PR, @awaelchli. Thanks!

@awaelchli awaelchli added bug Something isn't working logging Related to the `LoggerConnector` and `log()` community This PR is from the community labels Jul 18, 2024
@awaelchli awaelchli added this to the 2.3.x milestone Jul 18, 2024
@awaelchli
Copy link
Contributor

@clumsy with these small adjustments I commented on, this would be ready to land. I can also make the changes if you don't have time. Anyway, sorry for the delay.

@clumsy clumsy force-pushed the fix/move_existing_keys_to_device branch from 278d44e to 1dfbe7d Compare July 25, 2024 01:49
@mergify mergify bot removed the has conflicts label Jul 25, 2024
@awaelchli awaelchli changed the title fix: move results' keys to device (#19813) Fix moving keys to device in Result object Jul 26, 2024
@awaelchli awaelchli changed the title Fix moving keys to device in Result object Fix moving keys to device in ResultCollection Jul 26, 2024
The assertion was referencing the variable before the object was moved to device
Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81%. Comparing base (2064887) to head (0bd1563).
Report is 49 commits behind head on master.

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

HEAD has 274 uploads less than BASE
Flag BASE (2064887) HEAD (0bd1563)
cpu 83 21
lightning 61 16
pytest 46 2
python3.9 23 6
python3.10 24 6
lightning_fabric 13 0
python3.11 24 6
gpu 4 2
python3.12 12 3
pytorch2.1 23 12
pytest-full 41 21
pytorch2.2 6 3
pytorch2.3 6 3
pytorch_lightning 13 7
pytorch2.4 6 3
Additional details and impacted files
@@            Coverage Diff            @@
##           master   #19814     +/-   ##
=========================================
- Coverage      89%      81%     -8%     
=========================================
  Files         266      263      -3     
  Lines       22976    22920     -56     
=========================================
- Hits        20522    18556   -1966     
- Misses       2454     4364   +1910     

@awaelchli awaelchli merged commit b19eba3 into Lightning-AI:master Jul 26, 2024
74 of 75 checks passed
@awaelchli
Copy link
Contributor

Great fix, thanks @clumsy!

@clumsy clumsy deleted the fix/move_existing_keys_to_device branch August 1, 2024 18:28
ammyk9 pushed a commit to ammyk9/pytorch-lightning that referenced this pull request Aug 6, 2024
Co-authored-by: Alexander Jipa <azzhipa@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working community This PR is from the community logging Related to the `LoggerConnector` and `log()` pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Existing metric keys not moved to device after LearningRateFinder
3 participants