search

Lightning-AI / pytorch-lightning

Pretrain, finetune ANY AI model of ANY size on multiple GPUs, TPUs with zero code changes.
https://lightning.ai
Apache License 2.0
28.27k stars 3.38k forks source link

Broken links in Markdown Files #16186

Closed shenoynikhil closed 1 year ago

shenoynikhil commented 1 year ago

📚 Documentation

There are several broken links in markdown files present in this repository. Fixing this is crucial to having checks for broken links (#8107 and #16168). Broadly, the following markdown files have issues with links (the list of links are present in the markdown code block below)


FILE: ./examples/README.md
[✖] convert_from_pt_to_pl/image_classifier_4_dali.py → Status: 400

FILE: ./README.md
[✖] <https://dev.azure.com/Lightning-AI/lightning/_apis/build/status/pytorch-lightning%20(HPUs)?branchName=master> → Status: 400
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#byol → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#cpc-v2 → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#moco-v2-api → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#simclr → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/convolutional.html#gpt-2 → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#dqn-models → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#dueling-dqn → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#reinforce → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/classic_ml.html#logistic-regression → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/classic_ml.html#linear-regression → Status: 404

FILE: ./dockers/README.md
[✖] https://u.group/thinking/how-to-put-jupyter-notebooks-in-a-dockerfile → Status: 0

FILE: ./.github/CONTRIBUTING.md
[✖] https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork → Status: 403

FILE: ./src/lightning_app/README.md
[✖] https://lightning.ai/lightning-docs/install_beginner.html → Status: 404
[✖] https://lightning.ai/lightning-docs/lightning_apps_intro.html → Status: 404
[✖] https://lightning.ai/lightning-docs/lightning_apps_intro.html#define-root-component → Status: 404
[✖] https://www.lightning.ai/ → Status: 0

FILE: ./src/lightning_app/cli/component-template/README.md
[✖] lightning.ai → Status: 400

FILE: ./src/lightning_app/cli/app-template/README.md
[✖] lightning.ai → Status: 400

FILE: ./src/lightning_app/CHANGELOG.md
[✖] https://github.com/Ligtning-AI/lightning/pull/15748 → Status: 404

FILE: ./src/pytorch_lightning/README.md
[✖] ../docs/source-pytorch/_static/images/general/pl_quick_start_full_compressed.gif → Status: 400
[✖] <https://dev.azure.com/Lightning-AI/lightning/_apis/build/status/pytorch-lightning%20(HPUs)?branchName=master> → Status: 400
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#byol → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#cpc-v2 → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#moco-v2-api → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/self_supervised.html#simclr → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/convolutional.html#gpt-2 → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#dqn-models → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#dueling-dqn → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#reinforce → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/classic_ml.html#logistic-regression → Status: 404
[✖] https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/classic_ml.html#linear-regression → Status: 404

FILE: ./src/pytorch_lightning/CHANGELOG.md
[✖] https://github.,com/Lightning-AI/lightning/pull/14911 → Status: 0
[✖] https://github.com/Lightnign-AI/lightning/pull/15364 → Status: 404
[✖] https://github.com/Lightning-AI/lightning/14401 → Status: 404
[✖] https://github.com/Lightning-AI/lighting/pull/2904 → Status: 404

cc @borda

ShashwatAgrawal20 commented 1 year ago

would like to work on this