Rename optimization loops #16598

awaelchli · 2023-02-01T18:01:14Z

What does this PR do?

The internal OptimizerLoop class does no longer represent a real loop after #16539. We rename OptimizerLoop and ManualLoop to just AutomaticOptimization and ManualOptimization, which is more representative of what they do.

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 @justusschock @awaelchli @Borda @carmocca

for more information, see https://pre-commit.ci

…into refactor/rename-automatic-loop

for more information, see https://pre-commit.ci

src/lightning/pytorch/loops/optimization/manual.py

for more information, see https://pre-commit.ci

github-actions · 2023-02-02T13:55:10Z

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow

Check ID	Status
pl-cpu (macOS-11, lightning, 3.8, 1.11)	success	✅
pl-cpu (macOS-11, lightning, 3.9, 1.12)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
pl-cpu (macOS-11, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 1.11)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.12)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (windows-2022, lightning, 3.9, 1.11)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.12)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
pl-cpu (windows-2022, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (slow, macOS-11, lightning, 3.8, 1.11)	success	✅
pl-cpu (slow, ubuntu-20.04, lightning, 3.8, 1.11)	success	✅
pl-cpu (slow, windows-2022, lightning, 3.8, 1.11)	success	✅
pl-cpu (macOS-11, pytorch, 3.8, 1.13)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.13)	success	✅
pl-cpu (windows-2022, pytorch, 3.8, 1.13)	success	✅

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/optimization/test_optimizer_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_loop_state_dict.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/trainer/test_trainer.py, tests/tests_pytorch/utilities/migration/test_migration.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs)	success	✅

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/optimization/test_optimizer_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_loop_state_dict.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/trainer/test_trainer.py, tests/tests_pytorch/utilities/migration/test_migration.py.

🟢 pytorch_lightning: Azure HPU

Check ID	Status
pytorch-lightning (HPUs)	success	✅

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/optimization/test_optimizer_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_loop_state_dict.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/trainer/test_trainer.py, tests/tests_pytorch/utilities/migration/test_migration.py.

🟢 pytorch_lightning: Azure IPU

Check ID	Status
pytorch-lightning (IPUs)	success	✅

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/optimization/test_optimizer_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_loop_state_dict.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/trainer/test_trainer.py, tests/tests_pytorch/utilities/migration/test_migration.py.

🟢 pytorch_lightning: Docs

Check ID	Status
make-doctest (pytorch)	success	✅
make-html (pytorch)	success	✅

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py.

🟢 install

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

These checks are required after the changes to src/lightning/pytorch/loops/__init__.py, src/lightning/pytorch/loops/epoch/training_epoch_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/optimization/__init__.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/tuner/batch_size_scaling.py, src/lightning/pytorch/utilities/migration/migration.py.

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.

src/lightning/pytorch/loops/epoch/training_epoch_loop.py

for more information, see https://pre-commit.ci

awaelchli added 2 commits February 1, 2023 18:57

rename automatic optimization loop

07cc954

reference

afd83b3

awaelchli added refactor loops Related to the Loop API labels Feb 1, 2023

github-actions bot added the pl Generic label for PyTorch Lightning package label Feb 1, 2023

awaelchli added optimization and removed pl Generic label for PyTorch Lightning package labels Feb 1, 2023

awaelchli added this to the 2.0 milestone Feb 1, 2023

awaelchli self-assigned this Feb 1, 2023

[pre-commit.ci] auto fixes from pre-commit.com hooks

b4fe926

for more information, see https://pre-commit.ci

github-actions bot added the pl Generic label for PyTorch Lightning package label Feb 1, 2023

awaelchli and others added 5 commits February 1, 2023 19:06

rename attributes

eb7160b

Merge remote-tracking branch 'origin/refactor/rename-automatic-loop' …

45eb4c9

…into refactor/rename-automatic-loop

Merge branch 'master' into refactor/rename-automatic-loop

23184d0

fix merge conflicts

99e0bde

[pre-commit.ci] auto fixes from pre-commit.com hooks

015265c

for more information, see https://pre-commit.ci

awaelchli commented Feb 2, 2023

View reviewed changes

src/lightning/pytorch/loops/optimization/manual.py Outdated Show resolved Hide resolved

src/lightning/pytorch/loops/optimization/manual.py Outdated Show resolved Hide resolved

awaelchli and others added 3 commits February 2, 2023 08:29

Apply suggestions from code review

e725bc2

test

5608b88

[pre-commit.ci] auto fixes from pre-commit.com hooks

e21f2ce

for more information, see https://pre-commit.ci

awaelchli marked this pull request as ready for review February 2, 2023 13:54

awaelchli requested review from carmocca, justusschock and williamFalcon as code owners February 2, 2023 13:54

carmocca approved these changes Feb 2, 2023

View reviewed changes

Borda approved these changes Feb 2, 2023

View reviewed changes

mergify bot added the ready PRs ready to be merged label Feb 2, 2023

justusschock approved these changes Feb 2, 2023

View reviewed changes

src/lightning/pytorch/loops/epoch/training_epoch_loop.py Outdated Show resolved Hide resolved

Borda and others added 5 commits February 2, 2023 16:24

imports

9735045

[pre-commit.ci] auto fixes from pre-commit.com hooks

1a374d8

for more information, see https://pre-commit.ci

Merge branch 'master' into refactor/rename-automatic-loop

9aa0ec3

rename attributes

48a5b3d

fix if only one mode is checkpointed

07c6c1a

awaelchli enabled auto-merge (squash) February 2, 2023 21:01

awaelchli merged commit 6b70d17 into master Feb 2, 2023

awaelchli deleted the refactor/rename-automatic-loop branch February 2, 2023 21:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename optimization loops #16598

Rename optimization loops #16598

awaelchli commented Feb 1, 2023 •

edited by Borda

Loading

github-actions bot commented Feb 2, 2023 •

edited

Loading

Rename optimization loops #16598

Rename optimization loops #16598

Conversation

awaelchli commented Feb 1, 2023 • edited by Borda Loading

What does this PR do?

Before submitting

PR review

Did you have fun?

github-actions bot commented Feb 2, 2023 • edited Loading

⚡ Required checks status: All passing 🟢

Groups summary

awaelchli commented Feb 1, 2023 •

edited by Borda

Loading

github-actions bot commented Feb 2, 2023 •

edited

Loading