fix readme badges (#7354)
* fix readme badges * Apply suggestions from code review Co-authored-by: Ethan Harris <ewah1g13@soton.ac.uk> Co-authored-by: Ethan Harris <ewah1g13@soton.ac.uk>
This commit is contained in:
Jirka Borovec
GitHub
parent
374ff750f5
commit
bac4656eca
20
README.md
20
README.md
|
|
@ -58,7 +58,7 @@ Lightning forces the following structure to your code which makes it reusable an
|
|||
- Research code (the LightningModule).
|
||||
- Engineering code (you delete, and is handled by the Trainer).
|
||||
- Non-essential research code (logging, etc... this goes in Callbacks).
|
||||
- Data (use PyTorch Dataloaders or organize them into a LightningDataModule).
|
||||
- Data (use PyTorch DataLoaders or organize them into a LightningDataModule).
|
||||
|
||||
Once you do this, you can train on multiple-GPUs, TPUs, CPUs and even in 16-bit precision without changing your code!
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ Get started with our [2 step guide](https://pytorch-lightning.readthedocs.io/en/
|
|||
---
|
||||
|
||||
## Continuous Integration
|
||||
Lightning is rigurously tested across multiple GPUs, TPUs CPUs and against major Python and PyTorch versions.
|
||||
Lightning is rigorously tested across multiple GPUs, TPUs CPUs and against major Python and PyTorch versions.
|
||||
|
||||
<details>
|
||||
<summary>Current build statuses</summary>
|
||||
|
|
@ -77,15 +77,15 @@ Lightning is rigurously tested across multiple GPUs, TPUs CPUs and against major
|
|||
| System / PyTorch ver. | 1.4 (min. req.)* | 1.5 | 1.6 | 1.7 (latest) | 1.8 (nightly) |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
| Conda py3.7 [linux] | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22PyTorch+%26+Conda%22+branch%3Amaster) | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22PyTorch+%26+Conda%22+branch%3Amaster) | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22PyTorch+%26+Conda%22+branch%3Amaster) | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22PyTorch+%26+Conda%22+branch%3Amaster) | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22PyTorch+%26+Conda%22+branch%3Amaster) |
|
||||
| Linux py3.7 [GPUs**] | - | - | [](https://dev.azure.com/PytorchLightning/pytorch-lightning/_build/latest?definitionId=2&branchName=master) | - | - |
|
||||
| Linux py3.7 [GPUs**] | - | - | [?branchName=master)](https://dev.azure.com/PytorchLightning/pytorch-lightning/_build/latest?definitionId=6&branchName=master) | - | - |
|
||||
| Linux py3.{6,7} [TPUs***] | - | - | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22TPU+tests%22+branch%3Amaster) | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22TPU+tests%22+branch%3Amaster) |
|
||||
| Linux py3.{6,7,8,9} | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | - | - | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | - |
|
||||
| OSX py3.{6,7,8,9} | - | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | - | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | - |
|
||||
| Windows py3.{6,7,8,9} | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | - | - | [](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | - |
|
||||
|
||||
- _\** tests run on two NVIDIA K80_
|
||||
- _\** tests run on two NVIDIA P100_
|
||||
- _\*** tests run on Google GKE TPUv2/3_
|
||||
- _TPU w/ py3.6/py3.7 means we support Colab and Kaggle env._
|
||||
- _TPU py3.7 means we support Colab and Kaggle env._
|
||||
|
||||
</center>
|
||||
</details>
|
||||
|
|
@ -392,13 +392,13 @@ Grid AI is our platform for training models at scale on the cloud!
|
|||
To use grid, take your regular command:
|
||||
|
||||
```
|
||||
python my_model.py --learning_rate 1e-6 --layers 2 --gpus 4
|
||||
python my_model.py --learning_rate 1e-6 --layers 2 --gpus 4
|
||||
```
|
||||
|
||||
And change it to use the grid train command:
|
||||
|
||||
```
|
||||
grid train --grid_gpus 4 my_model.py --learning_rate 'uniform(1e-6, 1e-1, 20)' --layers '[2, 4, 8, 16]'
|
||||
grid train --grid_gpus 4 my_model.py --learning_rate 'uniform(1e-6, 1e-1, 20)' --layers '[2, 4, 8, 16]'
|
||||
```
|
||||
|
||||
The above command will launch (20 * 4) experiments each running on 4 GPUs (320 GPUs!) - by making ZERO changes to
|
||||
|
|
@ -408,11 +408,11 @@ your code.
|
|||
|
||||
## Licence
|
||||
|
||||
Please observe the Apache 2.0 license that is listed in this repository. In addition
|
||||
the Lightning framework is Patent Pending.
|
||||
Please observe the Apache 2.0 license that is listed in this repository.
|
||||
In addition, the Lightning framework is Patent Pending.
|
||||
|
||||
## BibTeX
|
||||
If you want to cite the framework feel free to use this (but only if you loved it 😊) or [zendo](https://zenodo.org/record/3828935#.YC45Lc9Khqs):
|
||||
If you want to cite the framework feel free to use this (but only if you loved it 😊) or [zenodo](https://zenodo.org/record/3828935#.YC45Lc9Khqs):
|
||||
|
||||
```bibtex
|
||||
@article{falcon2019pytorch,
|
||||
|
|
|
|||
Loading…
Reference in New Issue