Skip to content

Prefer local imports for optional dependencies #18551

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
Merged
merged 2 commits into from
Sep 14, 2023
Merged

Prefer local imports for optional dependencies #18551

merged 2 commits into from
Sep 14, 2023

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Sep 14, 2023 •
edited
Loading

What does this PR do?

Part of #12786
The PR moves imports to the local scope to delay the import. An import could be costly, and if a feature is not use it would be redundant to run the import globally. We should consistently follow this style for optional dependencies whenever possible.

📚 Documentation preview 📚: https://pytorch-lightning--18551.org.readthedocs.build/en/18551/

cc @justusschock @awaelchli @Borda

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Sep 14, 2023
@awaelchli awaelchli added refactor fun Staff contributions outside working hours - to differentiate from the "community" label and removed pl Generic label for PyTorch Lightning package labels Sep 14, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 14, 2023 •
edited
Loading

⚡ 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.10, 2.0) success ✅
pl-cpu (macOS-11, lightning, 3.8, 1.11, oldest) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 1.12) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.0) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest) success ✅
pl-cpu (windows-2022, lightning, 3.8, 1.11) success ✅
pl-cpu (windows-2022, lightning, 3.9, 1.12) success ✅
pl-cpu (windows-2022, lightning, 3.10, 1.13) success ✅
pl-cpu (windows-2022, lightning, 3.10, 2.0) success ✅
pl-cpu (windows-2022, lightning, 3.8, 1.11, oldest) 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 ✅
pl-cpu (macOS-12, pytorch, 3.11, 2.0) success ✅
pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.0) success ✅
pl-cpu (windows-2022, pytorch, 3.11, 2.0) success ✅

These checks are required after the changes to src/lightning/pytorch/callbacks/rich_model_summary.py, src/lightning/pytorch/core/saving.py, src/lightning/pytorch/demos/mnist_datamodule.py, src/lightning/pytorch/loggers/tensorboard.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/connectors/checkpoint_connector.py, src/lightning/pytorch/tuner/lr_finder.py, src/lightning/pytorch/utilities/deepspeed.py.

🟢 pytorch_lightning: Azure GPU
Check ID Status
[pytorch-lightning (GPUs) (testing Lightning latest)](https://dev.azure.com/Lightning-AI/72ab7ed8-b00f-4b6e-b131-3388f7ffafa7/_build/results?buildId=174471&view=logs&jobId=47e66f3c-897a-5428-da11-bf5c7745762e) success
[pytorch-lightning (GPUs) (testing PyTorch latest)](https://dev.azure.com/Lightning-AI/72ab7ed8-b00f-4b6e-b131-3388f7ffafa7/_build/results?buildId=174471&view=logs&jobId=3f274fac-2e11-54ca-487e-194c91f3ae9f) success

These checks are required after the changes to src/lightning/pytorch/callbacks/rich_model_summary.py, src/lightning/pytorch/core/saving.py, src/lightning/pytorch/demos/mnist_datamodule.py, src/lightning/pytorch/loggers/tensorboard.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/connectors/checkpoint_connector.py, src/lightning/pytorch/tuner/lr_finder.py, src/lightning/pytorch/utilities/deepspeed.py.

🟢 pytorch_lightning: Benchmarks
Check ID Status
lightning.Benchmarks success ✅

These checks are required after the changes to src/lightning/pytorch/callbacks/rich_model_summary.py, src/lightning/pytorch/core/saving.py, src/lightning/pytorch/demos/mnist_datamodule.py, src/lightning/pytorch/loggers/tensorboard.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/connectors/checkpoint_connector.py, src/lightning/pytorch/tuner/lr_finder.py, src/lightning/pytorch/utilities/deepspeed.py.

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

These checks are required after the changes to src/lightning/pytorch/callbacks/rich_model_summary.py, src/lightning/pytorch/core/saving.py, src/lightning/pytorch/demos/mnist_datamodule.py, src/lightning/pytorch/loggers/tensorboard.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/connectors/checkpoint_connector.py, src/lightning/pytorch/tuner/lr_finder.py, src/lightning/pytorch/utilities/deepspeed.py.

🟢 mypy
Check ID Status
mypy success ✅

These checks are required after the changes to src/lightning/pytorch/callbacks/rich_model_summary.py, src/lightning/pytorch/core/saving.py, src/lightning/pytorch/demos/mnist_datamodule.py, src/lightning/pytorch/loggers/tensorboard.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/connectors/checkpoint_connector.py, src/lightning/pytorch/tuner/lr_finder.py, src/lightning/pytorch/utilities/deepspeed.py.

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

These checks are required after the changes to src/lightning/pytorch/callbacks/rich_model_summary.py, src/lightning/pytorch/core/saving.py, src/lightning/pytorch/demos/mnist_datamodule.py, src/lightning/pytorch/loggers/tensorboard.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/strategies/ddp.py, src/lightning/pytorch/trainer/connectors/checkpoint_connector.py, src/lightning/pytorch/tuner/lr_finder.py, src/lightning/pytorch/utilities/deepspeed.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.

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Sep 14, 2023
@codecov
Copy link

codecov bot commented Sep 14, 2023 •
edited
Loading

Codecov Report

Merging #18551 (7c9cbf4) into master (1cee84c) will decrease coverage by 35%.
Report is 1 commits behind head on master.
The diff coverage is 84%.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #18551      +/-   ##
==========================================
- Coverage      85%      50%     -35%     
==========================================
  Files         427      419       -8     
  Lines       33376    33229     -147     
==========================================
- Hits        28342    16728   -11614     
- Misses       5034    16501   +11467

@mergify mergify bot added the ready PRs ready to be merged label Sep 14, 2023
@awaelchli awaelchli added this to the 2.1 milestone Sep 14, 2023
@awaelchli awaelchli merged commit 697f250 into master Sep 14, 2023
@awaelchli awaelchli deleted the refactor/local-imports branch September 14, 2023 10:26
@carmocca carmocca mentioned this pull request Nov 27, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Borda Borda Borda approved these changes

@carmocca carmocca carmocca approved these changes

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

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

Assignees
No one assigned
Labels
fun Staff contributions outside working hours - to differentiate from the "community" label performance pl Generic label for PyTorch Lightning package ready PRs ready to be merged refactor
Projects
None yet
Milestone
2.1
Development

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