Skip to content

Conversation

@awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Aug 28, 2023

What does this PR do?

Fixes #18083
Fixes #18216

Adds a standalone documentation guide for init_module and its use cases.
Covered for both Fabric and Trainer.
Linked in pages where appropriate.

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 @justusschock @awaelchli

@awaelchli awaelchli added the docs Documentation related label Aug 28, 2023
@awaelchli awaelchli added this to the 2.1 milestone Aug 28, 2023
@github-actions github-actions bot added fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package labels Aug 28, 2023
@awaelchli awaelchli marked this pull request as ready for review August 28, 2023 14:13
@github-actions
Copy link
Contributor

github-actions bot commented Aug 28, 2023

⚡ Required checks status: All passing 🟢

Groups summary

🟢 fabric: Docs
Check ID Status
docs-checks (fabric, doctest) success
make-html (fabric) success

These checks are required after the changes to docs/source-fabric/advanced/model_init.rst, docs/source-fabric/advanced/model_parallel/fsdp.rst, docs/source-fabric/api/fabric_methods.rst, docs/source-fabric/examples/index.rst, docs/source-fabric/fundamentals/precision.rst, docs/source-fabric/glossary/index.rst, docs/source-fabric/guide/checkpoint.rst, docs/source-fabric/guide/index.rst.

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

These checks are required after the changes to docs/source-pytorch/advanced/model_init.rst, docs/source-pytorch/advanced/model_parallel/deepspeed.rst, docs/source-pytorch/common/index.rst, docs/source-pytorch/common/precision_basic.rst, docs/source-pytorch/common/precision_intermediate.rst.


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 Aug 28, 2023
@awaelchli awaelchli merged commit d3ee410 into master Aug 28, 2023
@awaelchli awaelchli deleted the docs/init-module branch August 28, 2023 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document meta device initialization for FSDP Revamp model parallel docs in PL

3 participants