docs: fix links #17197

Borda · 2023-03-27T08:21:36Z

What does this PR do?

update links for LTS

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

github-actions · 2023-03-27T08:22:14Z

⛈️ 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, 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_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py, src/pytorch_lightning/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs)	success	✅

These checks are required after the changes to examples/pl_fault_tolerant/automatic.py, src/pytorch_lightning/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.py, src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py.

🟢 pytorch_lightning: Azure HPU

Check ID	Status
pytorch-lightning (HPUs)	success	✅

These checks are required after the changes to src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py, src/pytorch_lightning/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.py.

🔴 pytorch_lightning: Azure IPU

Check ID	Status
pytorch-lightning (IPUs)	failure	❌

These checks are required after the changes to src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py, src/pytorch_lightning/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.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/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.py, docs/source-pytorch/_templates/theme_variables.jinja, docs/source-pytorch/advanced/post_training_quantization.rst, docs/source-pytorch/ecosystem/community_examples.rst, docs/source-pytorch/index.rst, docs/source-pytorch/starter/style_guide.rst, .github/workflows/docs-build.yml.

🟢 lightning_fabric: CPU workflow

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

These checks are required after the changes to src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py.

🟢 lightning_fabric: Azure GPU

Check ID	Status
lightning-fabric (GPUs)	success	✅

These checks are required after the changes to examples/fabric/image_classifier/train_fabric.py, src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py.

🔴 lightning_app: Docs

Check ID	Status
make-doctest (app)	failure	❌
make-html (app)	failure	❌

These checks are required after the changes to docs/source-app/get_started/build_model.rst, .github/workflows/docs-build.yml.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/__about__.py, src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py, src/pytorch_lightning/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.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, fabric, 3.7)	success	✅
install-pkg (ubuntu-22.04, fabric, 3.10)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.7)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.10)	failure	❌
install-pkg (ubuntu-22.04, lightning, 3.7)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.10)	failure	❌
install-pkg (ubuntu-22.04, notset, 3.7)	success	✅
install-pkg (ubuntu-22.04, notset, 3.10)	failure	❌
install-pkg (macOS-12, app, 3.7)	success	✅
install-pkg (macOS-12, app, 3.10)	success	✅
install-pkg (macOS-12, fabric, 3.7)	success	✅
install-pkg (macOS-12, fabric, 3.10)	success	✅
install-pkg (macOS-12, pytorch, 3.7)	success	✅
install-pkg (macOS-12, pytorch, 3.10)	failure	❌
install-pkg (macOS-12, lightning, 3.7)	success	✅
install-pkg (macOS-12, lightning, 3.10)	failure	❌
install-pkg (macOS-12, notset, 3.7)	success	✅
install-pkg (macOS-12, notset, 3.10)	failure	❌
install-pkg (windows-2022, app, 3.7)	success	✅
install-pkg (windows-2022, app, 3.10)	success	✅
install-pkg (windows-2022, fabric, 3.7)	success	✅
install-pkg (windows-2022, fabric, 3.10)	success	✅
install-pkg (windows-2022, pytorch, 3.7)	success	✅
install-pkg (windows-2022, pytorch, 3.10)	failure	❌
install-pkg (windows-2022, lightning, 3.7)	success	✅
install-pkg (windows-2022, lightning, 3.10)	failure	❌
install-pkg (windows-2022, notset, 3.7)	success	✅
install-pkg (windows-2022, notset, 3.10)	failure	❌

These checks are required after the changes to src/lightning/__about__.py, src/lightning_fabric/__about__.py, src/lightning_fabric/__setup__.py, src/lightning_fabric/strategies/deepspeed.py, src/pytorch_lightning/__about__.py, src/pytorch_lightning/__setup__.py, src/pytorch_lightning/cli.py, src/pytorch_lightning/loops/epoch/training_epoch_loop.py, src/pytorch_lightning/strategies/deepspeed.py.

🟢 link-check

Check ID	Status
markdown-link-check	success	✅

These checks are required after the changes to README.md, examples/README.md, examples/fabric/dcgan/README.md, examples/fabric/image_classifier/README.md, examples/fabric/meta_learning/README.md, src/pytorch_lightning/README.md, tests/README.md.

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.

examples/pl_loops/yielding_training_step.py

codecov · 2023-03-27T08:34:24Z

Codecov Report

Merging #17197 (f8054f3) into release/LTS (62591cd) will decrease coverage by 20%.
The diff coverage is 100%.

Additional details and impacted files

@@              Coverage Diff               @@
##           release/LTS   #17197     +/-   ##
==============================================
- Coverage           82%      62%    -20%     
==============================================
  Files              476      435     -41     
  Lines            35261    34770    -491     
==============================================
- Hits             28741    21415   -7326     
- Misses            6520    13355   +6835

examples/README.md

Borda · 2023-03-27T18:34:54Z

included fix for #17199

Borda · 2023-03-27T20:25:00Z

Pkg install are addressed in #17208

replace dead links

8aea1f6

Borda added bug Something isn't working docs Documentation related labels Mar 27, 2023

Borda added this to the v1.9.x milestone Mar 27, 2023

Borda requested review from carmocca, williamFalcon, lantiga, edenlightning, awaelchli, justusschock and tchaton as code owners March 27, 2023 08:21

Borda enabled auto-merge (squash) March 27, 2023 08:21

github-actions bot added fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package labels Mar 27, 2023

awaelchli approved these changes Mar 27, 2023

View reviewed changes

awaelchli reviewed Mar 27, 2023

View reviewed changes

examples/pl_loops/yielding_training_step.py Show resolved Hide resolved

Borda mentioned this pull request Mar 27, 2023

Fix num_nodes not set for DDPFullyShardedNativeStrategy #17160

Merged

Borda mentioned this pull request Mar 27, 2023

ci: building LTS docs #17199

Merged

7 tasks

Borda requested review from akihironitta and a team March 27, 2023 10:51

akihironitta approved these changes Mar 27, 2023

View reviewed changes

mergify bot added the ready PRs ready to be merged label Mar 27, 2023

lantiga reviewed Mar 27, 2023

View reviewed changes

examples/README.md Show resolved Hide resolved

Borda added 2 commits March 27, 2023 20:23

Merge branch 'release/LTS' into docs/fix-links

dc2ac64

LTS

8ccb24e

github-actions bot added app Generic label for Lightning App package ci Continuous Integration labels Mar 27, 2023

Borda requested a review from lantiga March 27, 2023 18:30

Borda added 2 commits March 27, 2023 20:35

CI

99103c3

gc

f8054f3

lantiga approved these changes Mar 27, 2023

View reviewed changes

lexierule disabled auto-merge March 27, 2023 21:04

lexierule merged commit f46f09d into release/LTS Mar 27, 2023

lexierule deleted the docs/fix-links branch March 27, 2023 21:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix links #17197

docs: fix links #17197

Borda commented Mar 27, 2023 •

edited by github-actions bot

github-actions bot commented Mar 27, 2023 •

edited

codecov bot commented Mar 27, 2023 •

edited

Borda commented Mar 27, 2023

Borda commented Mar 27, 2023

docs: fix links #17197

docs: fix links #17197

Conversation

Borda commented Mar 27, 2023 • edited by github-actions bot

What does this PR do?

PR review

github-actions bot commented Mar 27, 2023 • edited

⛈️ Required checks status: Has failure 🔴

Groups summary

codecov bot commented Mar 27, 2023 • edited

Codecov Report

Borda commented Mar 27, 2023

Borda commented Mar 27, 2023

Borda commented Mar 27, 2023 •

edited by github-actions bot

github-actions bot commented Mar 27, 2023 •

edited

codecov bot commented Mar 27, 2023 •

edited