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 internal components as protected #17009

Merged
merged 2 commits into from Mar 9, 2023
Merged

Mark internal components as protected #17009

merged 2 commits into from Mar 9, 2023

Conversation

carmocca
Copy link
Member

@carmocca carmocca commented Mar 9, 2023

What does this PR do?

I'm auditing the PL API. These should be marked as protected as they are not meant to be public API

cc @Borda @justusschock @awaelchli @carmocca

@carmocca carmocca added refactor breaking change Includes a breaking change pl Generic label for PyTorch Lightning package labels Mar 9, 2023
@carmocca carmocca added this to the 2.0 milestone Mar 9, 2023
@carmocca carmocca self-assigned this Mar 9, 2023
@carmocca carmocca marked this pull request as ready for review March 9, 2023 02:48
@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2023 •
edited

⚡ 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 (macOS-11, lightning, 3.9, 2.0, pre) 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 (ubuntu-20.04, lightning, 3.9, 2.0, pre) 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 (windows-2022, lightning, 3.9, 2.0, pre) 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/evaluation_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/loops/prediction_loop.py, src/lightning/pytorch/loops/progress.py, src/lightning/pytorch/loops/training_epoch_loop.py, src/lightning/pytorch/loops/utilities.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/configuration_validator.py, src/lightning/pytorch/trainer/trainer.py, src/lightning/pytorch/utilities/distributed.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_progress.py.

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

These checks are required after the changes to src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/loops/prediction_loop.py, src/lightning/pytorch/loops/progress.py, src/lightning/pytorch/loops/training_epoch_loop.py, src/lightning/pytorch/loops/utilities.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/configuration_validator.py, src/lightning/pytorch/trainer/trainer.py, src/lightning/pytorch/utilities/distributed.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_progress.py.

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

These checks are required after the changes to src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/loops/prediction_loop.py, src/lightning/pytorch/loops/progress.py, src/lightning/pytorch/loops/training_epoch_loop.py, src/lightning/pytorch/loops/utilities.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/configuration_validator.py, src/lightning/pytorch/trainer/trainer.py, src/lightning/pytorch/utilities/distributed.py, tests/tests_pytorch/loops/test_loops.py, tests/tests_pytorch/loops/test_progress.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/evaluation_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/loops/prediction_loop.py, src/lightning/pytorch/loops/progress.py, src/lightning/pytorch/loops/training_epoch_loop.py, src/lightning/pytorch/loops/utilities.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/configuration_validator.py, src/lightning/pytorch/trainer/trainer.py, src/lightning/pytorch/utilities/distributed.py.

🟢 mypy
Check ID Status
mypy success ✅

These checks are required after the changes to src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/loops/prediction_loop.py, src/lightning/pytorch/loops/progress.py, src/lightning/pytorch/loops/training_epoch_loop.py, src/lightning/pytorch/loops/utilities.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/configuration_validator.py, src/lightning/pytorch/trainer/trainer.py, src/lightning/pytorch/utilities/distributed.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/evaluation_loop.py, src/lightning/pytorch/loops/fit_loop.py, src/lightning/pytorch/loops/loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/loops/prediction_loop.py, src/lightning/pytorch/loops/progress.py, src/lightning/pytorch/loops/training_epoch_loop.py, src/lightning/pytorch/loops/utilities.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/configuration_validator.py, src/lightning/pytorch/trainer/trainer.py, src/lightning/pytorch/utilities/distributed.py.

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

These checks are required after the changes to src/lightning/pytorch/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 Mar 9, 2023
@Borda Borda enabled auto-merge (squash) March 9, 2023 23:46
@Borda Borda merged commit 0f1f754 into master Mar 9, 2023
88 of 92 checks passed
@Borda Borda deleted the carmocca/more-protected branch March 9, 2023 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@awaelchli awaelchli awaelchli approved these changes

@Borda Borda Borda approved these changes

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

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

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

Assignees

@carmocca carmocca

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

Successfully merging this pull request may close these issues.

None yet
3 participants
@carmocca @awaelchli @Borda