Skip to content

Commit 5604226

Browse files
shenoynikhilNikhil ShenoyNikhil ShenoyNikhil ShenoyBorda
authored
Check broken links (#16168)
Co-authored-by: Nikhil Shenoy <[email protected]> Co-authored-by: Nikhil Shenoy <[email protected]> Co-authored-by: Nikhil Shenoy <[email protected]> Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Nikhil Shenoy <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Nikhil Shenoy <[email protected]> Co-authored-by: Nikhil Shenoy <[email protected]> Co-authored-by: Nikhil Shenoy <[email protected]> Fixes #8107
1 parent bd52181 commit 5604226

File tree

9 files changed

+62
-25
lines changed

9 files changed

+62
-25
lines changed

‎.github/workflows/check-md-links.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Check Markdown links
2+
# https://github.com/gaurav-nelson/github-action-markdown-link-check
3+
4+
on:
5+
push:
6+
branches: [master, "release/*"]
7+
pull_request:
8+
branches: [master, "release/*"]
9+
types: [opened, reopened, ready_for_review, synchronize]
10+
paths:
11+
- ".github/workflows/md-check-links.yml"
12+
- "**/*.md"
13+
14+
jobs:
15+
markdown-link-check:
16+
runs-on: ubuntu-20.04
17+
steps:
18+
- uses: actions/checkout@master
19+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
20+
with:
21+
use-quiet-mode: 'yes'
22+
config-file: '.github/workflows/markdown.links.config.json'

‎.github/workflows/markdown.links.config.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^https://github.com/Lightning-AI/lightning/pull/.*"
5+
}
6+
],
7+
"httpHeaders": [
8+
{
9+
"urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],
10+
"headers": {
11+
"Accept-Encoding": "zstd, br, gzip, deflate"
12+
}
13+
}
14+
]
15+
}

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,15 @@ Lightning is rigorously tested across multiple CPUs, GPUs, TPUs, IPUs, and HPUs
9090

9191
<center>
9292

93-
| System / PyTorch ver. | 1.10 | 1.12 |
94-
| :------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
95-
| Linux py3.7 \[GPUs\*\*\] | - | - |
96-
| Linux py3.7 \[TPUs\*\*\*\] | - | - |
97-
| Linux py3.8 \[IPUs\] | - | - |
98-
| Linux py3.8 \[HPUs\] | [![Build Status](<https://dev.azure.com/Lightning-AI/lightning/_apis/build/status/pytorch-lightning%20(HPUs)?branchName=master>)](https://dev.azure.com/Lightning-AI/lightning/_build/latest?definitionId=26&branchName=master) | - |
99-
| Linux py3.{7,9} | - | [![Test](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml/badge.svg?branch=master&event=push)](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml) |
100-
| OSX py3.{7,9} | - | [![Test](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml/badge.svg?branch=master&event=push)](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml) |
101-
| Windows py3.{7,9} | - | [![Test](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml/badge.svg?branch=master&event=push)](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml) |
93+
| System / PyTorch ver. | 1.10 | 1.12 |
94+
| :------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
95+
| Linux py3.7 \[GPUs\*\*\] | - | - |
96+
| Linux py3.7 \[TPUs\*\*\*\] | - | - |
97+
| Linux py3.8 \[IPUs\] | - | - |
98+
| Linux py3.8 \[HPUs\] | [![Build Status](https://dev.azure.com/Lightning-AI/lightning/_apis/build/status/pytorch-lightning%20%28HPUs%29?branchName=master)](https://dev.azure.com/Lightning-AI/lightning/_build/latest?definitionId=26&branchName=master) | - |
99+
| Linux py3.{7,9} | - | [![Test](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml/badge.svg?branch=master&event=push)](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml) |
100+
| OSX py3.{7,9} | - | [![Test](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml/badge.svg?branch=master&event=push)](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml) |
101+
| Windows py3.{7,9} | - | [![Test](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml/badge.svg?branch=master&event=push)](https://github.com/Lightning-AI/lightning/actions/workflows/ci-tests-pytorch.yml) |
102102

103103
- _\*\* tests run on two NVIDIA P100_
104104
- _\*\*\* tests run on Google GKE TPUv2/3. TPU py3.7 means we support Colab and Kaggle env._

‎examples/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ______________________________________________________________________
1313

1414
## Lightning Fabric Examples
1515

16-
We show how to accelerate your PyTorch code with [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/latest/starter/lightning_fabric.html) with minimal code changes.
16+
We show how to accelerate your PyTorch code with [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/latest/fabric/fabric.html) with minimal code changes.
1717
You stay in full control of the training loop.
1818

1919
- [MNIST: Vanilla PyTorch vs. Fabric](fabric/image_classifier/README.md)

‎examples/fabric/dcgan/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This is an example of a GAN (Generative Adversarial Network) that learns to generate realistic images of faces.
44
We show two code versions:
55
The first one is implemented in raw PyTorch, but isn't easy to scale.
6-
The second one is using [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/stable/starter/lightning_fabric.html) to accelerate and scale the model.
6+
The second one is using [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/latest/fabric/fabric.html) to accelerate and scale the model.
77

88
Tip: You can easily inspect the difference between the two files with:
99

‎examples/fabric/image_classifier/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Here are two MNIST classifiers implemented in PyTorch.
44
The first one is implemented in pure PyTorch, but isn't easy to scale.
5-
The second one is using [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/stable/starter/lightning_fabric.html) to accelerate and scale the model.
5+
The second one is using [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/latest/fabric/fabric.html) to accelerate and scale the model.
66

77
Tip: You can easily inspect the difference between the two files with:
88

@@ -23,7 +23,7 @@ ______________________________________________________________________
2323

2424
#### 2. Image Classifier with Lightning Fabric
2525

26-
This script shows you how to scale the pure PyTorch code to enable GPU and multi-GPU training using [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/stable/starter/lightning_fabric.html).
26+
This script shows you how to scale the pure PyTorch code to enable GPU and multi-GPU training using [Lightning Fabric](https://pytorch-lightning.readthedocs.io/en/latest/fabric/fabric.html).
2727

2828
```bash
2929
# CPU

‎examples/fabric/image_classifier/train_fabric.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
2626
Accelerate your training loop by setting the ``--accelerator``, ``--strategy``, ``--devices`` options directly from
2727
the command line. See ``lightning run model --help`` or learn more from the documentation:
28-
https://pytorch-lightning.readthedocs.io/en/latest/starter/lightning_fabric.html.
28+
https://pytorch-lightning.readthedocs.io/en/latest/fabric/fabric.html.
2929
"""
3030

3131
import argparse

‎src/lightning_app/cli/app-template/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Once the app is installed, run it locally with:
2020
lightning run app placeholdername/app.py
2121
```
2222

23-
Run it on the [lightning cloud](lightning.ai) with:
23+
Run it on the [lightning cloud](https://lightning.ai/) with:
2424

2525
```bash
2626
lightning run app placeholdername/app.py --cloud

0 commit comments

Comments
 (0)