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: fix broken links #20590

Merged
merged 2 commits into from
Feb 14, 2025
Merged

docs: fix broken links #20590

merged 2 commits into from
Feb 14, 2025

Conversation

Borda
Copy link
Member

@Borda Borda commented Feb 14, 2025 •
edited by github-actions bot
Loading

What does this PR do?

some pages doe snot exists any more and this block our release workflow

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

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

cc @Borda @lantiga @justusschock

@github-actions github-actions bot added docs Documentation related ci Continuous Integration fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package package labels Feb 14, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 14, 2025 •
edited
Loading

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow
Check ID Status
pl-cpu (macOS-14, 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.2) success ✅
pl-cpu (macOS-14, lightning, 3.11, 2.3) success ✅
pl-cpu (macOS-14, lightning, 3.12.7, 2.4.1) success ✅
pl-cpu (macOS-14, lightning, 3.12.7, 2.5.1) 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.2) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.11, 2.3) success ✅
pl-cpu (ubuntu-22.04, lightning, 3.12.7, 2.4.1) success ✅
pl-cpu (ubuntu-22.04, lightning, 3.12.7, 2.5.1) success ✅
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.2) success ✅
pl-cpu (windows-2022, lightning, 3.11, 2.3) success ✅
pl-cpu (windows-2022, lightning, 3.12.7, 2.4.1) success ✅
pl-cpu (windows-2022, lightning, 3.12.7, 2.5.1) success ✅
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-14, pytorch, 3.12.7, 2.5.1) success ✅
pl-cpu (ubuntu-22.04, pytorch, 3.12.7, 2.5.1) success ✅
pl-cpu (windows-2022, pytorch, 3.12.7, 2.5.1) success ✅

These checks are required after the changes to src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning_fabric/__setup__.py, src/lightning/pytorch/callbacks/stochastic_weight_avg.py, src/lightning/pytorch/plugins/precision/xla.py, src/lightning/pytorch/strategies/launchers/multiprocessing.py, src/lightning/pytorch/strategies/launchers/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, src/pytorch_lightning/__setup__.py, tests/tests_pytorch/callbacks/test_early_stopping.py, tests/tests_pytorch/callbacks/test_stochastic_weight_avg.py, tests/tests_pytorch/core/test_datamodules.py, tests/tests_pytorch/profilers/test_profiler.py, tests/tests_pytorch/trainer/logging_/test_train_loop_logging.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/__setup__.py, src/lightning/pytorch/callbacks/stochastic_weight_avg.py, src/lightning/pytorch/plugins/precision/xla.py, src/lightning/pytorch/strategies/launchers/multiprocessing.py, src/lightning/pytorch/strategies/launchers/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, src/pytorch_lightning/__setup__.py, tests/tests_pytorch/callbacks/test_early_stopping.py, tests/tests_pytorch/callbacks/test_stochastic_weight_avg.py, tests/tests_pytorch/core/test_datamodules.py, tests/tests_pytorch/profilers/test_profiler.py, tests/tests_pytorch/trainer/logging_/test_train_loop_logging.py, src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning_fabric/__setup__.py.

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

These checks are required after the changes to src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning/pytorch/callbacks/stochastic_weight_avg.py, src/lightning/pytorch/plugins/precision/xla.py, src/lightning/pytorch/strategies/launchers/multiprocessing.py, src/lightning/pytorch/strategies/launchers/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.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/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning_fabric/__setup__.py, docs/source-fabric/_templates/theme_variables.jinja, docs/source-fabric/links.rst.

🟢 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/stochastic_weight_avg.py, src/lightning/pytorch/plugins/precision/xla.py, src/lightning/pytorch/strategies/launchers/multiprocessing.py, src/lightning/pytorch/strategies/launchers/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, src/pytorch_lightning/__setup__.py, docs/source-pytorch/_templates/theme_variables.jinja, docs/source-pytorch/accelerators/accelerator_prepare.rst, docs/source-pytorch/accelerators/gpu_intermediate.rst, docs/source-pytorch/advanced/ddp_optimizations.rst, docs/source-pytorch/advanced/model_parallel/deepspeed.rst, docs/source-pytorch/data/alternatives.rst, docs/source-pytorch/data/iterables.rst, docs/source-pytorch/links.rst, docs/source-pytorch/versioning.rst.

🟢 lightning_fabric: CPU workflow
Check ID Status
fabric-cpu (macOS-14, 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.2) success ✅
fabric-cpu (macOS-14, lightning, 3.11, 2.3) success ✅
fabric-cpu (macOS-14, lightning, 3.12.7, 2.4.1) success ✅
fabric-cpu (macOS-14, lightning, 3.12.7, 2.5.1) 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.2) success ✅
fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.3) success ✅
fabric-cpu (ubuntu-22.04, lightning, 3.12.7, 2.4.1) success ✅
fabric-cpu (ubuntu-22.04, lightning, 3.12.7, 2.5.1) 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.2) success ✅
fabric-cpu (windows-2022, lightning, 3.11, 2.3) success ✅
fabric-cpu (windows-2022, lightning, 3.12.7, 2.4.1) success ✅
fabric-cpu (windows-2022, lightning, 3.12.7, 2.5.1) 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-14, fabric, 3.12.7, 2.5.1) success ✅
fabric-cpu (ubuntu-22.04, fabric, 3.12.7, 2.5.1) success ✅
fabric-cpu (windows-2022, fabric, 3.12.7, 2.5.1) success ✅

These checks are required after the changes to src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning_fabric/__setup__.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/__setup__.py, src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning_fabric/__setup__.py.

🟢 mypy
Check ID Status
mypy success ✅

These checks are required after the changes to src/lightning/__setup__.py, src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning/pytorch/callbacks/stochastic_weight_avg.py, src/lightning/pytorch/plugins/precision/xla.py, src/lightning/pytorch/strategies/launchers/multiprocessing.py, src/lightning/pytorch/strategies/launchers/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, src/lightning_fabric/__setup__.py, src/pytorch_lightning/__setup__.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-14, fabric, 3.9) success ✅
install-pkg (macOS-14, fabric, 3.11) success ✅
install-pkg (macOS-14, pytorch, 3.9) success ✅
install-pkg (macOS-14, pytorch, 3.11) success ✅
install-pkg (macOS-14, lightning, 3.9) success ✅
install-pkg (macOS-14, lightning, 3.11) success ✅
install-pkg (macOS-14, notset, 3.9) success ✅
install-pkg (macOS-14, 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/__setup__.py, src/lightning/fabric/plugins/environments/kubeflow.py, src/lightning/fabric/strategies/launchers/multiprocessing.py, src/lightning/fabric/strategies/launchers/subprocess_script.py, src/lightning/pytorch/callbacks/stochastic_weight_avg.py, src/lightning/pytorch/plugins/precision/xla.py, src/lightning/pytorch/strategies/launchers/multiprocessing.py, src/lightning/pytorch/strategies/launchers/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, src/lightning_fabric/__setup__.py, src/pytorch_lightning/__setup__.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.

@mergify mergify bot added the ready PRs ready to be merged label Feb 14, 2025
@codecov Codecov
Copy link

codecov bot commented Feb 14, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 88%. Comparing base (9afcc58) to head (32e8454).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #20590   +/-   ##
=======================================
  Coverage      88%      88%           
=======================================
  Files         267      267           
  Lines       23369    23369           
=======================================
  Hits        20478    20478           
  Misses       2891     2891

@Borda Borda merged commit 4eda5a0 into master Feb 14, 2025
103 checks passed
@Borda Borda deleted the docs/fix-links branch February 14, 2025 22:57
Borda added a commit that referenced this pull request Feb 14, 2025
@Borda
docs: fix broken links (#20590)
d0979d4 
(cherry picked from commit 4eda5a0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@williamFalcon williamFalcon williamFalcon approved these changes

@ethanwharris ethanwharris ethanwharris approved these changes

@robTheBuildr robTheBuildr robTheBuildr approved these changes

@vivequeramji vivequeramji vivequeramji approved these changes

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

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

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

Assignees
No one assigned
Labels
ci Continuous Integration docs Documentation related fabric lightning.fabric.Fabric package pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Borda @williamFalcon @ethanwharris @robTheBuildr @vivequeramji