Update README.md
This commit is contained in:
William Falcon
GitHub
parent
ecf995bad9
commit
e839d3bc22
59
README.md
59
README.md
|
|
@ -47,18 +47,19 @@ Lightning disentangles PyTorch code to decouple the science from the engineering
|
|||
|
||||
---
|
||||
|
||||
## Lightning Philosophy
|
||||
Lightning is designed with these principles in mind:
|
||||
## Lightning Design Philosophy
|
||||
Lightning structures PyTorch code with these principles:
|
||||
|
||||
Principle 1: Enable maximal flexibility.
|
||||
Principle 2: Abstract away unnecessary boilerplate, but make it accessible when needed.
|
||||
Principle 3: Systems should be self-contained (ie: optimizers, computation code, etc).
|
||||
Principle 4: Deep learning code should be organized into 4 distinct categories.
|
||||
<div align="center">
|
||||
<img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/philosophies.jpg" max-height="250px">
|
||||
</div>
|
||||
|
||||
- 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).
|
||||
Lightning forces the following structure to your code which makes it reusable and shareable:
|
||||
|
||||
- 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).
|
||||
|
||||
Once you do this, you can train on multiple-GPUs, TPUs, CPUs and even in 16-bit precision without changing your code!
|
||||
|
||||
|
|
@ -66,29 +67,29 @@ Get started with our [2 step guide](https://pytorch-lightning.readthedocs.io/en/
|
|||
|
||||
---
|
||||
|
||||
## Inference
|
||||
Lightning is also designed for the fast inference AI researchers and production teams need to scale up things like BERT and self-supervised learning.
|
||||
Lightning can automatically export to ONNX or TorchScript for those cases.
|
||||
|
||||
---
|
||||
|
||||
## Continuous Integration
|
||||
<center>
|
||||
Lightning is rigurously tested across multiple GPUs, TPUs CPUs and against major Python and PyTorch versions.
|
||||
|
||||
| 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.{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} | [](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} | - | [](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} | [](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) | - |
|
||||
<details>
|
||||
<summary>Current build statuses</summary>
|
||||
|
||||
<center>
|
||||
|
||||
- _\** tests run on two NVIDIA K80_
|
||||
- _\*** tests run on Google GKE TPUv2/3_
|
||||
- _TPU w/ py3.6/py3.7 means we support Colab and Kaggle env._
|
||||
| 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.{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} | [](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} | - | [](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} | [](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) | - |
|
||||
|
||||
</center>
|
||||
- _\** tests run on two NVIDIA K80_
|
||||
- _\*** tests run on Google GKE TPUv2/3_
|
||||
- _TPU w/ py3.6/py3.7 means we support Colab and Kaggle env._
|
||||
|
||||
</center>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue