Always use the local rank zero imports #16178

carmocca · 2022-12-22T17:27:05Z

What does this PR do?

Avoids theoretical

RuntimeError: The `rank_zero_only.rank` needs to be set before use

This could happen if a module was used standalone

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

None

cc @Borda @justusschock @awaelchli

github-actions · 2022-12-22T17:27:38Z

⚡ 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/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py, src/pytorch_lightning/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs)	success	✅

These checks are required after the changes to src/pytorch_lightning/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.py, src/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py.

🟢 pytorch_lightning: Azure HPU

Check ID	Status
pytorch-lightning (HPUs)	success	✅

These checks are required after the changes to src/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py, src/pytorch_lightning/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.py.

🟢 pytorch_lightning: Azure IPU

Check ID	Status
pytorch-lightning (IPUs)	success	✅

These checks are required after the changes to src/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py, src/pytorch_lightning/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.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/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.py.

🟢 lightning_lite: CPU workflow

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

These checks are required after the changes to src/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py.

🟢 lightning_lite: Azure GPU

Check ID	Status
lightning-lite (GPUs)	success	✅

These checks are required after the changes to src/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py, src/pytorch_lightning/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.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, lite, 3.7)	success	✅
install-pkg (ubuntu-22.04, lite, 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, lite, 3.7)	success	✅
install-pkg (macOS-12, lite, 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, lite, 3.7)	success	✅
install-pkg (windows-2022, lite, 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_lite/lite.py, src/lightning_lite/plugins/environments/slurm.py, src/lightning_lite/strategies/deepspeed.py, src/lightning_lite/utilities/rank_zero.py, src/lightning_lite/utilities/seed.py, src/pytorch_lightning/accelerators/accelerator.py, src/pytorch_lightning/callbacks/early_stopping.py, src/pytorch_lightning/callbacks/model_checkpoint.py, src/pytorch_lightning/core/module.py, src/pytorch_lightning/lite/lite.py, src/pytorch_lightning/loops/epoch/prediction_epoch_loop.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/loops/optimization/optimizer_loop.py, src/pytorch_lightning/plugins/precision/colossalai.py, src/pytorch_lightning/plugins/precision/deepspeed.py, src/pytorch_lightning/plugins/precision/ipu.py, src/pytorch_lightning/profilers/pytorch.py, src/pytorch_lightning/strategies/colossalai.py, src/pytorch_lightning/strategies/deepspeed.py, src/pytorch_lightning/trainer/connectors/data_connector.py, src/pytorch_lightning/trainer/connectors/logger_connector/result.py, src/pytorch_lightning/trainer/states.py, src/pytorch_lightning/utilities/data.py, src/pytorch_lightning/utilities/migration/migration.py, src/pytorch_lightning/utilities/migration/utils.py, src/pytorch_lightning/utilities/model_summary/model_summary.py, src/pytorch_lightning/utilities/rank_zero.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.

* [App] Introduce basic auth to Lightning CLI (#16105) * Introduce basic auth to Lightning CLI for app creation * Parsing creds added * Adding auth field to app instance body * Adding tests * Adding changelog entry * Adding more tests * Update runtime.py * Setting auth on update * Fix test * Update lightning-cloud dep * Apply suggestions from code review Co-authored-by: Adrian Wälchli <[email protected]> * Update runtime.py * Fix for release * Update base.txt Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Adrian Wälchli <[email protected]> * docs: fix order of on_fit_start() hook (#16180) Fixes #16170 * docs: updated broken links (#16191) Co-authored-by: Shashwat <shashwat> Fixes #16186 * Always use the local rank zero imports (#16178) * update BYOC documentation with AWS details (#16044) Co-authored-by: Adrian Wälchli <[email protected]> * Using internal ip + port in a load balancer instead of URL exposed (#16119) Co-authored-by: thomas chaton <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Remove CUDA_LAUNCH_BLOCKING from Lite tests (#16177) * simplify torch.Tensor (#16190) * Fix inclusion of `model_parallel` document (#16197) fix link to gpu/advanced section * Update numpy requirement from <1.23.1,>=1.17.2 to >=1.17.2,<1.24.1 in /requirements (#16199) Update numpy requirement in /requirements Updates the requirements on [numpy](https://github.com/numpy/numpy) to permit the latest version. - [Release notes](https://github.com/numpy/numpy/releases) - [Changelog](https://github.com/numpy/numpy/blob/main/doc/RELEASE_WALKTHROUGH.rst) - [Commits](numpy/numpy@v1.17.2...v1.24.0) --- updated-dependencies: - dependency-name: numpy dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update s3fs requirement from <2022.8.3,>=2022.5.0 to >=2022.5.0,<2022.11.1 in /requirements (#16198) Update s3fs requirement in /requirements Updates the requirements on [s3fs](https://github.com/fsspec/s3fs) to permit the latest version. - [Release notes](https://github.com/fsspec/s3fs/releases) - [Changelog](https://github.com/fsspec/s3fs/blob/main/release-procedure.md) - [Commits](fsspec/s3fs@2022.5.0...2022.11.0) --- updated-dependencies: - dependency-name: s3fs dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ci: upload only with release (#16194) * Update endpoint access examples: added info about accessing auth-protected apps (#16145) * Skip a failing Bagua test for manual optimization (#16225) * Fix type error when dividing chunk size in colossalai strategy (#16212) Co-authored-by: awaelchli <[email protected]> * Fix DDP on XLA (#16020) Co-authored-by: awaelchli <[email protected]> * Added support and test for custom artifact names in WandbLogger (#16173) * Update ipython[all] requirement from <8.6.1 to <8.7.1 in /requirements (#16220) Updates the requirements on [ipython[all]](https://github.com/ipython/ipython) to permit the latest version. - [Release notes](https://github.com/ipython/ipython/releases) - [Commits](ipython/ipython@rel-0.8.4...8.7.0) --- updated-dependencies: - dependency-name: ipython[all] dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Improvements to checkpoint migration (#16233) Co-authored-by: Justus Schock <[email protected]> * Support arbitrary `Optimizable`s as optimizers (#16189) * Differences with master Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Dmitry Frolov <[email protected]> Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Adrian Wälchli <[email protected]> Co-authored-by: David Gilbertson <[email protected]> Co-authored-by: Shashwat Agrawal <[email protected]> Co-authored-by: Raphael Randschau <[email protected]> Co-authored-by: thomas chaton <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: HELSON <[email protected]> Co-authored-by: Liyang90 <[email protected]> Co-authored-by: Manan Goel <[email protected]> Co-authored-by: Justus Schock <[email protected]>

Always use the local rank zero imports

82c452f

carmocca added the refactor label Dec 22, 2022

carmocca added this to the v1.9 milestone Dec 22, 2022

carmocca requested review from awaelchli and justusschock as code owners December 22, 2022 17:27

carmocca self-assigned this Dec 22, 2022

carmocca requested review from williamFalcon and tchaton as code owners December 22, 2022 17:27

github-actions bot added the pl Generic label for PyTorch Lightning package label Dec 22, 2022

awaelchli approved these changes Dec 22, 2022

View reviewed changes

carmocca enabled auto-merge (squash) December 22, 2022 22:17

Borda approved these changes Dec 24, 2022

View reviewed changes

carmocca merged commit 612d43e into master Dec 24, 2022

carmocca deleted the refactor/rank-zero-imports branch December 24, 2022 03:22

mergify bot added the ready PRs ready to be merged label Dec 24, 2022

carmocca added a commit that referenced this pull request Jan 3, 2023

Always use the local rank zero imports (#16178)

5e876f1

carmocca mentioned this pull request Nov 20, 2023

Fix rank_zero_only rank not set in ddp-spawn based strategies #19030

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Always use the local rank zero imports #16178

Always use the local rank zero imports #16178

carmocca commented Dec 22, 2022 •

edited by github-actions bot

Loading

github-actions bot commented Dec 22, 2022 •

edited

Loading

Always use the local rank zero imports #16178

Always use the local rank zero imports #16178

Conversation

carmocca commented Dec 22, 2022 • edited by github-actions bot Loading

What does this PR do?

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

github-actions bot commented Dec 22, 2022 • edited Loading

⚡ Required checks status: All passing 🟢

Groups summary

carmocca commented Dec 22, 2022 •

edited by github-actions bot

Loading

github-actions bot commented Dec 22, 2022 •

edited

Loading