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

Mark the loop classes as protected #16445

Merged
merged 6 commits into from
Jan 23, 2023
Merged

Mark the loop classes as protected #16445

merged 6 commits into from
Jan 23, 2023

Conversation

carmocca
Copy link
Contributor

@carmocca carmocca commented Jan 19, 2023 •
edited by github-actions bot
Loading

What does this PR do?

Since loops are not meant to be customized anymore, these APIs are now protected.

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

The class names have changed.

cc @justusschock @awaelchli @Borda @carmocca

@carmocca carmocca added refactor breaking change Includes a breaking change loops Related to the Loop API pl Generic label for PyTorch Lightning package labels Jan 19, 2023
@carmocca carmocca added this to the 2.0 milestone Jan 19, 2023
@carmocca carmocca self-assigned this Jan 19, 2023
@github-actions github-actions bot removed the pl Generic label for PyTorch Lightning package label Jan 19, 2023
@carmocca carmocca marked this pull request as ready for review January 19, 2023 18:17
@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 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/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/test_evaluation_loop.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/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/utilities/test_fetching.py.

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

These checks are required after the changes to src/pytorch_lightning/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/test_evaluation_loop.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/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/utilities/test_fetching.py.

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

These checks are required after the changes to src/pytorch_lightning/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/test_evaluation_loop.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/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/utilities/test_fetching.py.

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

These checks are required after the changes to src/pytorch_lightning/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.py, tests/tests_pytorch/loops/epoch/test_training_epoch_loop.py, tests/tests_pytorch/loops/test_evaluation_loop.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/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/utilities/test_fetching.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/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.py, docs/source-pytorch/api_references.rst, docs/source-pytorch/starter/introduction.rst.

🟢 lightning_app: Tests workflow
Check ID Status
app-pytest (macOS-11, app, 3.8, latest) success ✅
app-pytest (macOS-11, app, 3.8, oldest) success ✅
app-pytest (macOS-11, lightning, 3.9, latest) success ✅
app-pytest (ubuntu-20.04, app, 3.8, latest) success ✅
app-pytest (ubuntu-20.04, app, 3.8, oldest) success ✅
app-pytest (ubuntu-20.04, lightning, 3.9, latest) success ✅
app-pytest (windows-2022, app, 3.8, latest) success ✅
app-pytest (windows-2022, app, 3.8, oldest) success ✅
app-pytest (windows-2022, lightning, 3.8, latest) success ✅

These checks are required after the changes to src/lightning_app/utilities/introspection.py, tests/tests_app/core/scripts/lightning_overrides.py, tests/tests_app/utilities/test_introspection.py.

🟢 lightning_app: Examples
Check ID Status
app-examples (macOS-11, app, 3.9, latest) success ✅
app-examples (macOS-11, app, 3.9, oldest) success ✅
app-examples (macOS-11, lightning, 3.9, latest) success ✅
app-examples (ubuntu-20.04, app, 3.9, latest) success ✅
app-examples (ubuntu-20.04, app, 3.9, oldest) success ✅
app-examples (ubuntu-20.04, lightning, 3.9, latest) success ✅
app-examples (windows-2022, app, 3.9, latest) success ✅
app-examples (windows-2022, app, 3.9, oldest) success ✅
app-examples (windows-2022, lightning, 3.9, latest) success ✅

These checks are required after the changes to src/lightning_app/utilities/introspection.py.

🟢 lightning_app: Azure
Check ID Status
App.cloud-e2e success ✅

These checks are required after the changes to src/lightning_app/utilities/introspection.py.

🟢 lightning_app: Docs
Check ID Status
make-doctest (app) success ✅
make-html (app) success ✅

These checks are required after the changes to src/lightning_app/utilities/introspection.py.

🟢 mypy
Check ID Status
mypy success ✅

These checks are required after the changes to src/lightning_app/utilities/introspection.py, src/pytorch_lightning/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.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/lightning_app/utilities/introspection.py, src/pytorch_lightning/loops/__init__.py, src/pytorch_lightning/loops/dataloader/__init__.py, src/pytorch_lightning/loops/dataloader/dataloader_loop.py, src/pytorch_lightning/loops/dataloader/evaluation_loop.py, src/pytorch_lightning/loops/dataloader/prediction_loop.py, src/pytorch_lightning/loops/epoch/__init__.py, src/pytorch_lightning/loops/epoch/evaluation_epoch_loop.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/fit_loop.py, src/pytorch_lightning/loops/loop.py, src/pytorch_lightning/loops/optimization/__init__.py, src/pytorch_lightning/loops/optimization/manual_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/loops/utilities.py, src/pytorch_lightning/trainer/trainer.py.

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

These checks are required after the changes to README.md, src/pytorch_lightning/CHANGELOG.md, src/pytorch_lightning/README.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 19, 2023
@carmocca carmocca force-pushed the refactor/loop-protected branch from 8b36cc1 to 3543699 Compare January 19, 2023 23:19
@carmocca carmocca enabled auto-merge (squash) January 23, 2023 13:03
@carmocca carmocca merged commit 5891cdc into master Jan 23, 2023
@carmocca carmocca deleted the refactor/loop-protected branch January 23, 2023 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justusschock justusschock justusschock approved these changes

@Borda Borda Borda approved these changes

@awaelchli awaelchli awaelchli approved these changes

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

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

@edenlightning edenlightning Awaiting requested review from edenlightning

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

@hhsecond hhsecond Awaiting requested review from hhsecond

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

Assignees

@carmocca carmocca

Labels
breaking change Includes a breaking change loops Related to the Loop API ready PRs ready to be merged refactor
Projects
None yet
Milestone
2.0
Development

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