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.

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

docs: fix removed ref to deepspeed.initialize #20353

Merged
merged 3 commits into from
Oct 21, 2024
Merged

Conversation

Borda
Copy link
Member

@Borda Borda commented Oct 20, 2024

What does this PR do?

seems like deepspeed does not generate API for this function anymore and this breaks the compilation of our whole docs

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

@Borda Borda added docs Documentation related priority: 1 Medium priority task labels Oct 20, 2024
@github-actions github-actions bot added fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package labels Oct 20, 2024
Copy link
Contributor

github-actions bot commented Oct 20, 2024

⛈️ 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-13, lightning, 3.9, 2.1, oldest) success
pl-cpu (macOS-14, lightning, 3.10, 2.1) success
pl-cpu (macOS-14, lightning, 3.11, 2.2) success
pl-cpu (macOS-14, lightning, 3.11, 2.3) success
pl-cpu (macOS-14, lightning, 3.12, 2.4) success
pl-cpu (ubuntu-20.04, lightning, 3.9, 2.1, oldest) success
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.1) success
pl-cpu (ubuntu-20.04, lightning, 3.11, 2.2) success
pl-cpu (ubuntu-20.04, lightning, 3.11, 2.3) success
pl-cpu (ubuntu-20.04, lightning, 3.12, 2.4) failure
pl-cpu (windows-2022, lightning, 3.9, 2.1, oldest) success
pl-cpu (windows-2022, lightning, 3.10, 2.1) success
pl-cpu (windows-2022, lightning, 3.11, 2.2) failure
pl-cpu (windows-2022, lightning, 3.11, 2.3) success
pl-cpu (windows-2022, lightning, 3.12, 2.4) failure
pl-cpu (macOS-14, pytorch, 3.9, 2.1) success
pl-cpu (ubuntu-20.04, pytorch, 3.9, 2.1) success
pl-cpu (windows-2022, pytorch, 3.9, 2.1) success
pl-cpu (macOS-12, pytorch, 3.10, 2.1) success
pl-cpu (ubuntu-22.04, pytorch, 3.10, 2.1) success
pl-cpu (windows-2022, pytorch, 3.10, 2.1) success

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py, src/lightning/pytorch/strategies/deepspeed.py.

🟢 pytorch_lightning: Azure GPU
Check ID Status
pytorch-lightning (GPUs) (testing Lightning | latest) success
pytorch-lightning (GPUs) (testing PyTorch | latest) success

These checks are required after the changes to src/lightning/pytorch/strategies/deepspeed.py, src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py.

🟢 pytorch_lightning: Benchmarks
Check ID Status
lightning.Benchmarks success

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py, src/lightning/pytorch/strategies/deepspeed.py.

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

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.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/strategies/deepspeed.py, docs/source-pytorch/accelerators/tpu_advanced.rst, docs/source-pytorch/accelerators/tpu_basic.rst, docs/source-pytorch/accelerators/tpu_faq.rst.

🔴 lightning_fabric: CPU workflow
Check ID Status
fabric-cpu (macOS-13, lightning, 3.9, 2.1, oldest) success
fabric-cpu (macOS-14, lightning, 3.10, 2.1) success
fabric-cpu (macOS-14, lightning, 3.11, 2.2) success
fabric-cpu (macOS-14, lightning, 3.11, 2.3) success
fabric-cpu (macOS-14, lightning, 3.12, 2.4) success
fabric-cpu (ubuntu-20.04, lightning, 3.9, 2.1, oldest) success
fabric-cpu (ubuntu-20.04, lightning, 3.10, 2.1) success
fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.2) success
fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.3) success
fabric-cpu (ubuntu-20.04, lightning, 3.12, 2.4) success
fabric-cpu (windows-2022, lightning, 3.9, 2.1, oldest) success
fabric-cpu (windows-2022, lightning, 3.10, 2.1) success
fabric-cpu (windows-2022, lightning, 3.11, 2.2) failure
fabric-cpu (windows-2022, lightning, 3.11, 2.3) success
fabric-cpu (windows-2022, lightning, 3.12, 2.4) success
fabric-cpu (macOS-14, fabric, 3.9, 2.1) success
fabric-cpu (ubuntu-20.04, fabric, 3.9, 2.1) success
fabric-cpu (windows-2022, fabric, 3.9, 2.1) success
fabric-cpu (macOS-12, fabric, 3.10, 2.1) success
fabric-cpu (ubuntu-22.04, fabric, 3.10, 2.1) success
fabric-cpu (windows-2022, fabric, 3.10, 2.1) success

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py.

🟢 lightning_fabric: Azure GPU
Check ID Status
lightning-fabric (GPUs) (testing Fabric | latest) success
lightning-fabric (GPUs) (testing Lightning | latest) success

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py.

🟢 mypy
Check ID Status
mypy success

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py, src/lightning/pytorch/strategies/deepspeed.py.

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

These checks are required after the changes to src/lightning/fabric/strategies/deepspeed.py, src/lightning/fabric/strategies/xla_fsdp.py, src/lightning/pytorch/strategies/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.

Copy link

codecov bot commented Oct 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89%. Comparing base (af19dda) to head (009e0f6).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #20353   +/-   ##
=======================================
  Coverage      89%      89%           
=======================================
  Files         267      267           
  Lines       23065    23065           
=======================================
  Hits        20574    20574           
  Misses       2491     2491           

@mergify mergify bot added the ready PRs ready to be merged label Oct 21, 2024
@lexierule lexierule merged commit 0e1e14f into master Oct 21, 2024
92 of 97 checks passed
@lexierule lexierule deleted the docs/deepspeed branch October 21, 2024 13:47
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 priority: 1 Medium priority task ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants