Skip to content

Commit

Permalink
fix nightly releases & readme (#5922)
Browse files Browse the repository at this point in the history
* fix nightly releases

* readme

* cuda

* doxker

* Apply suggestions from code review

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

* revert

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
  • Loading branch information
Borda and carmocca committed Feb 16, 2021
1 parent a22ec15 commit b5d7d08
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 28 deletions.
18 changes: 8 additions & 10 deletions .github/workflows/ci_dockers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,21 +75,21 @@ jobs:
matrix:
include:
# todo: see notes in Dockerfile
#- python_version: 3.7
# pytorch_version: 1.8
- python_version: 3.8
pytorch_version: 1.7
- python_version: 3.7
pytorch_version: 1.6
- python_version: 3.6
pytorch_version: 1.4
- python_version: 3.7
pytorch_version: 1.6
- python_version: 3.8
pytorch_version: 1.7
#- python_version: 3.9
# pytorch_version: 1.8
steps:
- name: Checkout
uses: actions/checkout@v2

# for PT 1.3 and 1.4 we need to use CUDA 10.1
# for PT 1.4 we need to use CUDA 10.1
- run: |
cuda=$(python -c "print(10.2 if float(${{matrix.pytorch_version}}) > 1.4 else 10.1)" 2>&1)
cuda=$(python -c "print(10.2 if float(${{matrix.pytorch_version}}) >= 1.5 else 10.1)" 2>&1)
echo "::set-output name=CUDA::$cuda"
id: extend
Expand All @@ -114,8 +114,6 @@ jobs:
fail-fast: false
matrix:
include:
- python_version: 3.8
pytorch_version: 1.6
- python_version: 3.6
pytorch_version: 1.4
- python_version: 3.7
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/events-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ jobs:
steps:
# does nightly releases from feature branch
- uses: actions/checkout@v2
with:
ref: release/1.2-dev
- uses: actions/setup-python@v2
with:
python-version: 3.7
Expand Down
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,41 +115,51 @@ Simple installation from PyPI
pip install pytorch-lightning
```

<!-- following section will be skipped from PyPI description -->
<details>
<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)
#### Install with optional dependencies

```bash
pip install pytorch-lightning['extra']
```

#### Conda

```bash
conda install pytorch-lightning -c conda-forge
```

#### Install stable - future 1.1.x

the actual status of 1.1 [stable] is following:

![CI base testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20base%20testing/badge.svg?branch=release%2F1.1.x&event=push)
![CI complete testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20complete%20testing/badge.svg?branch=release%2F1.1.x&event=push)
![PyTorch & Conda](https://github.com/PyTorchLightning/pytorch-lightning/workflows/PyTorch%20&%20Conda/badge.svg?branch=release%2F1.1.x&event=push)
![TPU tests](https://github.com/PyTorchLightning/pytorch-lightning/workflows/TPU%20tests/badge.svg?branch=release%2F1.1.x&event=push)
![Docs check](https://github.com/PyTorchLightning/pytorch-lightning/workflows/Docs%20check/badge.svg?branch=release%2F1.1.x&event=push)

Install future release from the source
```bash
pip install git+https://github.com/PytorchLightning/pytorch-lightning.git@release/1.1.x --upgrade
```

#### Install bleeding-edge - future 1.2

Install future release from the source (no guarantees)
Install nightly from the source (no guarantees)
```bash
pip install git+https://github.com/PytorchLightning/pytorch-lightning.git@release/1.2-dev --upgrade
pip install https://github.com/PyTorchLightning/pytorch-lightning/archive/master.zip
```
or nightly from testing PyPI

or from testing PyPI
```bash
pip install -iU https://test.pypi.org/simple/ pytorch-lightning
```

<!-- end skipping PyPI description -->
</details>

<!-- end skipping PyPI description -->

### Step 1: Add these imports

Expand Down Expand Up @@ -369,8 +379,8 @@ class LitAutoEncoder(pl.LightningModule):
## Community
The lightning community is maintained by
- [16 core contributors](https://pytorch-lightning.readthedocs.io/en/latest/governance.html) who are all a mix of professional engineers, Research Scientists, Ph.D. students from top AI labs.
- 280+ community contributors.
- [16 core contributors](https://pytorch-lightning.readthedocs.io/en/latest/governance.html) who are all a mix of professional engineers, Research Scientists, and Ph.D. students from top AI labs.
- 400+ community contributors.
Lightning is also part of the [PyTorch ecosystem](https://pytorch.org/ecosystem/) which requires projects to have solid testing, documentation and support.
Expand Down
2 changes: 1 addition & 1 deletion dockers/base-xla/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ RUN \
conda info && \
pip list && \
python -c "import sys; assert sys.version[:3] == '$PYTHON_VERSION', sys.version" && \
python -c "import torch; ver = '$XLA_VERSION' ; ver = dict(nightly='1.8').get(ver, ver) ; assert torch.__version__[:3] == ver, torch.__version__"
python -c "import torch; ver = '$XLA_VERSION' ; ver = dict(nightly='1.9').get(ver, ver) ; assert torch.__version__[:3] == ver, torch.__version__"

0 comments on commit b5d7d08

Please sign in to comment.