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.

Sign up for GitHub

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

Jump to bottom

Remove optimizer_idx from toggle/untoggle_optimizer methods #16560

Merged
merged 6 commits into from
Jan 30, 2023
Merged

Remove optimizer_idx from toggle/untoggle_optimizer methods #16560

merged 6 commits into from
Jan 30, 2023

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Jan 30, 2023 •
edited by github-actions bot
Loading

What does this PR do?

Part of #16539

Since #16539 removes the concept of optimizer index, and toggle/untoggle methods will be useful for working with multiple optimizers in manual optimization, this PR makes it more convenient to use these methods by taking the optimizer object directly instead of the index.

Does your PR introduce any breaking changes? If yes, please list them.

Argument optimizer_idx gets removed from both methods. Part of the Trainer 2.0 loop simplification initiative.

Before submitting

  • Was this discussed/approved 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 update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

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

  • 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

Did you have fun?

I made sure I had fun coding 🙃

cc @Borda @justusschock @carmocca @awaelchli

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jan 30, 2023
@awaelchli awaelchli added breaking change Includes a breaking change lightningmodule pl.LightningModule optimization and removed pl Generic label for PyTorch Lightning package labels Jan 30, 2023
@awaelchli awaelchli self-assigned this Jan 30, 2023
@awaelchli awaelchli added this to the 2.0 milestone Jan 30, 2023
@awaelchli awaelchli changed the title Remove optimizer_idx from LightningModule.toggle/untoggle_optimizer Remove optimizer_idx from toggle/untoggle_optimizer methods Jan 30, 2023
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jan 30, 2023
@awaelchli awaelchli marked this pull request as ready for review January 30, 2023 13:45
@github-actions
Copy link
Contributor

github-actions bot commented Jan 30, 2023 •
edited
Loading

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow
Check ID Status
pl-cpu (macOS-11, pytorch, 3.8, 1.11) success ✅
pl-cpu (macOS-11, pytorch, 3.9, 1.12) success ✅
pl-cpu (macOS-11, pytorch, 3.10, 1.13) success ✅
pl-cpu (macOS-11, pytorch, 3.8, 1.10, oldest) success ✅
pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.10) success ✅
pl-cpu (ubuntu-20.04, pytorch, 3.9, 1.11) success ✅
pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.12) success ✅
pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.13) success ✅
pl-cpu (ubuntu-20.04, pytorch, 3.7, 1.10, oldest) success ✅
pl-cpu (windows-2022, pytorch, 3.9, 1.11) success ✅
pl-cpu (windows-2022, pytorch, 3.10, 1.12) success ✅
pl-cpu (windows-2022, pytorch, 3.10, 1.13) success ✅
pl-cpu (windows-2022, pytorch, 3.7, 1.10, oldest) success ✅
pl-cpu (slow, macOS-11, pytorch, 3.7, 1.11) success ✅
pl-cpu (slow, ubuntu-20.04, pytorch, 3.7, 1.11) success ✅
pl-cpu (slow, windows-2022, pytorch, 3.7, 1.11) success ✅
pl-cpu (macOS-11, lightning, 3.8, 1.13) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.13) success ✅
pl-cpu (windows-2022, lightning, 3.8, 1.13) success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, tests/tests_pytorch/core/test_lightning_module.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/advanced_models.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py.

🟢 pytorch_lightning: Azure GPU
Check ID Status
pytorch-lightning (GPUs) success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, tests/tests_pytorch/core/test_lightning_module.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/advanced_models.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py.

🟢 pytorch_lightning: Azure HPU
Check ID Status
pytorch-lightning (HPUs) success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, tests/tests_pytorch/core/test_lightning_module.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/advanced_models.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py.

🟢 pytorch_lightning: Azure IPU
Check ID Status
pytorch-lightning (IPUs) success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, tests/tests_pytorch/core/test_lightning_module.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/advanced_models.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py.

🟢 pytorch_lightning: Docs
Check ID Status
make-doctest (pytorch) success ✅
make-html (pytorch) success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py.

🟢 mypy
Check ID Status
mypy success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py.

🟢 install
Check ID Status
install-pkg (ubuntu-22.04, app, 3.7) success ✅
install-pkg (ubuntu-22.04, app, 3.10) success ✅
install-pkg (ubuntu-22.04, fabric, 3.7) success ✅
install-pkg (ubuntu-22.04, fabric, 3.10) success ✅
install-pkg (ubuntu-22.04, pytorch, 3.7) success ✅
install-pkg (ubuntu-22.04, pytorch, 3.10) success ✅
install-pkg (ubuntu-22.04, lightning, 3.7) success ✅
install-pkg (ubuntu-22.04, lightning, 3.10) success ✅
install-pkg (ubuntu-22.04, notset, 3.7) success ✅
install-pkg (ubuntu-22.04, notset, 3.10) success ✅
install-pkg (macOS-12, app, 3.7) success ✅
install-pkg (macOS-12, app, 3.10) success ✅
install-pkg (macOS-12, fabric, 3.7) success ✅
install-pkg (macOS-12, fabric, 3.10) success ✅
install-pkg (macOS-12, pytorch, 3.7) success ✅
install-pkg (macOS-12, pytorch, 3.10) success ✅
install-pkg (macOS-12, lightning, 3.7) success ✅
install-pkg (macOS-12, lightning, 3.10) success ✅
install-pkg (macOS-12, notset, 3.7) success ✅
install-pkg (macOS-12, notset, 3.10) success ✅
install-pkg (windows-2022, app, 3.7) success ✅
install-pkg (windows-2022, app, 3.10) success ✅
install-pkg (windows-2022, fabric, 3.7) success ✅
install-pkg (windows-2022, fabric, 3.10) success ✅
install-pkg (windows-2022, pytorch, 3.7) success ✅
install-pkg (windows-2022, pytorch, 3.10) success ✅
install-pkg (windows-2022, lightning, 3.7) success ✅
install-pkg (windows-2022, lightning, 3.10) success ✅
install-pkg (windows-2022, notset, 3.7) success ✅
install-pkg (windows-2022, notset, 3.10) success ✅

These checks are required after the changes to src/pytorch_lightning/core/module.py, src/pytorch_lightning/core/optimizer.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py.

🟢 link-check
Check ID Status
markdown-link-check success ✅

These checks are required after the changes to src/pytorch_lightning/CHANGELOG.md.

Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

@mergify mergify bot added the ready PRs ready to be merged label Jan 30, 2023
@awaelchli awaelchli mentioned this pull request Jan 30, 2023
Merged
11 tasks
@awaelchli awaelchli enabled auto-merge (squash) January 30, 2023 17:27
@awaelchli awaelchli merged commit c2aa8c9 into master Jan 30, 2023
@awaelchli awaelchli deleted the removal/toggle-optimizer branch January 30, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carmocca carmocca carmocca approved these changes

@justusschock justusschock justusschock approved these changes

@Borda Borda Borda approved these changes

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

Assignees

@awaelchli awaelchli

Labels
breaking change Includes a breaking change lightningmodule pl.LightningModule optimization pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@awaelchli @Borda @carmocca @justusschock