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

docs: update pytorch_lightning imports #16864

Merged
merged 13 commits into from
Feb 27, 2023
Merged

docs: update pytorch_lightning imports #16864

merged 13 commits into from
Feb 27, 2023

Conversation

Borda
Copy link
Member

@Borda Borda commented Feb 24, 2023 •
edited by github-actions bot
Loading

What does this PR do?

unify references and imports in examples to be lightning.

Before submitting
  • Was this discussed/agreed 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 list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • 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

cc @Borda @carmocca @akihironitta

@github-actions
Copy link
Contributor

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

⛈️ Required checks status: Has failure 🔴

Warning
This job will need to be re-run to merge your PR. If you do not have write access to the repository, you can ask Lightning-AI/lai-frameworks to re-run it. If you push a new commit, all of CI will re-trigger.

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 (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/core/hooks.py.

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

These checks are required after the changes to src/lightning/pytorch/core/hooks.py.

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

These checks are required after the changes to src/lightning/pytorch/core/hooks.py.

🔴 pytorch_lightning: Docs
Check ID Status
make-doctest (pytorch) failure ❌
make-html (pytorch) failure ❌

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, docs/source-pytorch/accelerators/accelerator_prepare.rst, docs/source-pytorch/accelerators/gpu_intermediate.rst, docs/source-pytorch/accelerators/hpu_basic.rst, docs/source-pytorch/accelerators/hpu_intermediate.rst, docs/source-pytorch/accelerators/ipu_advanced.rst, docs/source-pytorch/accelerators/ipu_basic.rst, docs/source-pytorch/accelerators/ipu_intermediate.rst, docs/source-pytorch/accelerators/tpu_advanced.rst, docs/source-pytorch/accelerators/tpu_faq.rst, docs/source-pytorch/accelerators/tpu_intermediate.rst, docs/source-pytorch/advanced/model_parallel.rst, docs/source-pytorch/advanced/post_training_quantization.rst, docs/source-pytorch/advanced/pruning_quantization.rst, docs/source-pytorch/advanced/strategy_registry.rst, docs/source-pytorch/advanced/third_party/colossalai.rst, docs/source-pytorch/advanced/training_tricks.rst, docs/source-pytorch/api_references.rst, docs/source-pytorch/cli/lightning_cli_advanced.rst, docs/source-pytorch/cli/lightning_cli_advanced_2.rst, docs/source-pytorch/cli/lightning_cli_advanced_3.rst, docs/source-pytorch/cli/lightning_cli_expert.rst, docs/source-pytorch/cli/lightning_cli_faq.rst, docs/source-pytorch/cli/lightning_cli_intermediate.rst, docs/source-pytorch/cli/lightning_cli_intermediate_2.rst, docs/source-pytorch/clouds/cluster_advanced.rst, docs/source-pytorch/clouds/cluster_expert.rst, docs/source-pytorch/common/checkpointing.rst, docs/source-pytorch/common/checkpointing_advanced.rst, docs/source-pytorch/common/checkpointing_expert.rst, docs/source-pytorch/common/checkpointing_intermediate.rst, docs/source-pytorch/common/checkpointing_migration.rst, docs/source-pytorch/common/child_modules.rst, docs/source-pytorch/common/console_logs.rst, docs/source-pytorch/common/early_stopping.rst, docs/source-pytorch/common/evaluation_intermediate.rst, docs/source-pytorch/common/gradient_accumulation.rst, docs/source-pytorch/common/lightning_module.rst, docs/source-pytorch/common/optimization.rst, docs/source-pytorch/common/precision_expert.rst, docs/source-pytorch/common/progress_bar.rst, docs/source-pytorch/common/remote_fs.rst, docs/source-pytorch/common/trainer.rst, docs/source-pytorch/conf.py, docs/source-pytorch/data/datamodule.rst, docs/source-pytorch/debug/debugging_basic.rst, docs/source-pytorch/debug/debugging_intermediate.rst, docs/source-pytorch/deploy/production_advanced.rst, docs/source-pytorch/deploy/production_advanced_2.rst, docs/source-pytorch/deploy/production_basic.rst, docs/source-pytorch/ecosystem/bolts.rst, docs/source-pytorch/ecosystem/community_examples.rst, docs/source-pytorch/extensions/accelerator.rst, docs/source-pytorch/extensions/callbacks.rst, docs/source-pytorch/extensions/callbacks_state.rst, docs/source-pytorch/extensions/entry_points.rst, docs/source-pytorch/extensions/logging.rst, docs/source-pytorch/extensions/plugins.rst, docs/source-pytorch/extensions/strategy.rst, docs/source-pytorch/fabric/advanced/distributed_communication.rst, docs/source-pytorch/fabric/advanced/gradient_accumulation.rst, docs/source-pytorch/fabric/api/api_reference.rst, docs/source-pytorch/fabric/api/fabric_methods.rst, docs/source-pytorch/fabric/api/utilities.rst, docs/source-pytorch/fabric/fundamentals/convert.rst, docs/source-pytorch/fabric/fundamentals/launch.rst, docs/source-pytorch/fabric/fundamentals/notebooks.rst, docs/source-pytorch/fabric/fundamentals/precision.rst, docs/source-pytorch/fabric/guide/callbacks.rst, docs/source-pytorch/fabric/guide/checkpoint.rst, docs/source-pytorch/fabric/guide/logging.rst, docs/source-pytorch/fabric/guide/multi_node/slurm.rst, docs/source-pytorch/guides/data.rst, docs/source-pytorch/guides/speed.rst, docs/source-pytorch/model/manual_optimization.rst, docs/source-pytorch/model/train_model_basic.rst, docs/source-pytorch/starter/converting.rst, docs/source-pytorch/starter/introduction.rst, docs/source-pytorch/starter/style_guide.rst, docs/source-pytorch/tuning/profiler_advanced.rst, docs/source-pytorch/tuning/profiler_basic.rst, docs/source-pytorch/tuning/profiler_expert.rst, docs/source-pytorch/tuning/profiler_intermediate.rst, docs/source-pytorch/visualize/experiment_managers.rst, docs/source-pytorch/visualize/logging_advanced.rst, docs/source-pytorch/visualize/logging_expert.rst, docs/source-pytorch/visualize/logging_intermediate.rst, docs/source-pytorch/visualize/supported_exp_managers.rst, .github/workflows/docs-checks.yml.

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

These checks are required after the changes to .github/workflows/docs-checks.yml.

🟢 mypy
Check ID Status
mypy success ✅

These checks are required after the changes to src/lightning/pytorch/core/hooks.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/core/hooks.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 Feb 24, 2023
@Borda Borda requested a review from akihironitta as a code owner February 24, 2023 07:47
@github-actions github-actions bot added the ci Continuous Integration label Feb 24, 2023
awaelchli
awaelchli approved these changes Feb 24, 2023
View reviewed changes
carmocca
carmocca approved these changes Feb 24, 2023
View reviewed changes
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check the references in the docstrings too in a follow-up?

@mergify mergify bot added the ready PRs ready to be merged label Feb 24, 2023
@Borda
Copy link
Member Author

Borda commented Feb 24, 2023

Can you check the references in the docstrings too in a follow-up?

they were already done in #16594 but checked again and there was just one missing 2c97cda

@mergify mergify bot added has conflicts and removed ready PRs ready to be merged labels Feb 25, 2023
@mergify mergify bot added ready PRs ready to be merged has conflicts and removed has conflicts ready PRs ready to be merged labels Feb 27, 2023
@mergify mergify bot removed the ready PRs ready to be merged label Feb 27, 2023
carmocca
carmocca reviewed Feb 27, 2023
View reviewed changes
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "pytorch" docs fail to build because they import lightning but the app requirements are not installed.

Since the docs will be merged, should the docs jobs be merged too?

.github/workflows/docs-checks.yml Outdated
@@ -6,7 +6,7 @@ on:
branches: ["master", "release/*"]
# use this event type to share secrets with forks.
# it's important that the PR head SHA is checked out to run the changes
pull_request_target:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Firnedly "FIXME" reminder

@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Feb 27, 2023
@mergify mergify bot added has conflicts and removed ready PRs ready to be merged labels Feb 27, 2023
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Feb 27, 2023
@lexierule lexierule merged commit 52a39c0 into master Feb 27, 2023
@lexierule lexierule deleted the docs/pytorch branch February 27, 2023 20:14
@Borda Borda added this to the v1.9.x milestone Feb 27, 2023
@Borda
Copy link
Member Author

Borda commented Feb 27, 2023

This need to be picked for building 1.9 docs as RTFD does not allow define env. variable in yaml file...

@Borda Borda mentioned this pull request Feb 27, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carmocca carmocca carmocca approved these changes

@awaelchli awaelchli awaelchli approved these changes

@edenlightning edenlightning Awaiting requested review from edenlightning

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

@akihironitta akihironitta Awaiting requested review from akihironitta

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

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

Assignees
No one assigned
Labels
ci Continuous Integration pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Milestone
v1.9.x
Development

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