Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
William Falcon 2021-02-13 13:50:18 -05:00 committed by GitHub
parent e839d3bc22
commit 11942558d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -91,6 +91,19 @@ Lightning is rigurously tested across multiple GPUs, TPUs CPUs and against major
</center>
</details>
<details>
<summary>Bleeding edge build status (1.2)</summary>
<center>
![CI base testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20base%20testing/badge.svg?branch=release%2F1.2-dev&event=push)
![CI complete testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20complete%20testing/badge.svg?branch=release%2F1.2-dev&event=push)
![PyTorch & Conda](https://github.com/PyTorchLightning/pytorch-lightning/workflows/PyTorch%20&%20Conda/badge.svg?branch=release%2F1.2-dev&event=push)
![TPU tests](https://github.com/PyTorchLightning/pytorch-lightning/workflows/TPU%20tests/badge.svg?branch=release%2F1.2-dev&event=push)
![Docs check](https://github.com/PyTorchLightning/pytorch-lightning/workflows/Docs%20check/badge.svg?branch=release%2F1.2-dev&event=push)
</center>
</details>
---
## How To Use
@ -101,27 +114,30 @@ Simple installation from PyPI
```bash
pip install pytorch-lightning
```
_To get full package experience you can install also all optional dependencies with `pytorch-lightning['extra']` or for CPU users with `pytorch-lightning['cpu-extra']`._
From Conda
```bash
conda install pytorch-lightning -c conda-forge
```
<details>
<summary>Other options</summary>
<summary>Other installation options</summary>
<!-- following section will be skipped from PyPI description -->
#### Install with optional dependencies (CPU)
```bash
pip install pytorch-lightning['cpu-extra']
```
#### Install with optional dependencies (GPU, TPU)
```bash
pip install pytorch-lightning['extra']
```
#### Conda
```bash
conda install pytorch-lightning -c conda-forge
```
#### Install bleeding-edge - future 1.2
the actual status of 1.2 [nightly] is following:
![CI base testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20base%20testing/badge.svg?branch=release%2F1.2-dev&event=push)
![CI complete testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20complete%20testing/badge.svg?branch=release%2F1.2-dev&event=push)
![PyTorch & Conda](https://github.com/PyTorchLightning/pytorch-lightning/workflows/PyTorch%20&%20Conda/badge.svg?branch=release%2F1.2-dev&event=push)
![TPU tests](https://github.com/PyTorchLightning/pytorch-lightning/workflows/TPU%20tests/badge.svg?branch=release%2F1.2-dev&event=push)
![Docs check](https://github.com/PyTorchLightning/pytorch-lightning/workflows/Docs%20check/badge.svg?branch=release%2F1.2-dev&event=push)
Install future release from the source (no guarantees)
```bash
pip install git+https://github.com/PytorchLightning/pytorch-lightning.git@release/1.2-dev --upgrade