Skip to content

Conversation

@shenoynikhil
Copy link
Contributor

@shenoynikhil shenoynikhil commented Jan 4, 2023

What does this PR do?

Fixes links referred to in #16234.
Fixes #8107

Fixed the following links

  • All the 4 example links in callback examples
  • Two links the lightning transformer page, in the seamless memory and optimization point. Both Deepspeed and FairScale shared links.
  • QConfig link in the docstring for Quantization Aware Training example
  • Online-training for recurrent neural networks paper link in common/lightning_module.rst Link
  • Efficient Data Batching link in docstrings was incorrect for IPU Strategy
  • Opening reports with graph analyser in IPU Strategy Link (last link on this page)
  • deepspeed3 offload link is incorrect in two places, model parallel and fabric (prev lite)
  • Updated the reference link for make_pruning_permanent() in ModelPruning Callback
  • Linkchecker fails on a few relative links (as listed below), added them to lincheck_ignore in conf.py
(common/hyperparameters: line   14) broken    ../cli/lightning_cli.html - 
(starter/introduction: line  182) broken    ../common/trainer.html#trainer-flags - 
(starter/introduction: line  102) broken    installation.html - 
(           index: line   65) broken    starter/installation.html - 

Fix the following links

(notebooks/lightning_examples/augmentation_kornia: line  128) broken    https://www.kornia.org - HTTPSConnectionPool(host='www.kornia.org', port=443): Max retries exceeded with url: / (Caused by SSLError(SSLEOFError(8, 'EOF occurred in violation of protocol (_ssl.c:1131)')))

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved 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:

  • 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

Did you have fun?

Make sure you had fun coding 🙃

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jan 4, 2023
@shenoynikhil shenoynikhil changed the title Fixes in sphinx docs links and skip CHANGELOG check Fixes in sphinx docs links Jan 4, 2023
@shenoynikhil
Copy link
Contributor Author

@Borda @awaelchli This is ready for review.

The kornia.org link in notebooks/lightning_examples/augmentation_kornia does not work (it is kornia.github.io now). When I run the linkcheck in my local, it shows this error, but it is showing that the build is successful here.

@awaelchli awaelchli added docs Documentation related community This PR is from the community labels Jan 5, 2023
@awaelchli awaelchli added this to the v1.9 milestone Jan 5, 2023
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

LGTM after comments addressed

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@mergify mergify bot added the ready PRs ready to be merged label Jan 9, 2023
@awaelchli awaelchli requested a review from Borda January 9, 2023 10:07
@Borda Borda merged commit 5a9b5e3 into Lightning-AI:master Jan 10, 2023
@shenoynikhil shenoynikhil deleted the fix-sphinx-docs-links branch January 20, 2023 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community This PR is from the community docs Documentation related 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.

Testing URL links in docs & readme

5 participants