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

releasing feature as nightly (#5233) 

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
(cherry picked from commit c479351a93)
This commit is contained in:
Jirka Borovec 2020-12-23 21:29:00 +01:00 committed by Jirka Borovec
parent 52c3081b4c
commit 5e71c88096
2 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/nightly.yml vendored
View File

@ -13,7 +13,10 @@ jobs:
runs-on: ubuntu-20.04
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
@ -29,7 +32,6 @@ jobs:
ls -lh dist/
- name: Delay releasing
if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'release'
uses: juliangruber/sleep-action@v1
with:
time: 5m

28
README.md
View File

@ -101,7 +101,7 @@ Lightning can automatically export to ONNX or TorchScript for those cases.
## How To Use
#### Step 0: Install
### Step 0: Install
Simple installation from PyPI
```bash
@ -114,12 +114,26 @@ From Conda
conda install pytorch-lightning -c conda-forge
```
Install bleeding-edge (no guarantees)
#### 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@master --upgrade
pip install git+https://github.com/PytorchLightning/pytorch-lightning.git@release/1.2-dev --upgrade
```
or nightly from testing PyPI
```bash
pip install -iU https://test.pypi.org/simple/ pytorch-lightning
```
#### Step 0: Add these imports
### Step 1: Add these imports
```python
import os
@ -132,7 +146,7 @@ from torchvision import transforms
import pytorch_lightning as pl
```
#### Step 1: Define a LightningModule (nn.Module subclass)
### Step 2: Define a LightningModule (nn.Module subclass)
A LightningModule defines a full *system* (ie: a GAN, autoencoder, BERT or a simple Image Classifier).
```python
@ -163,9 +177,9 @@ class LitAutoEncoder(pl.LightningModule):
return optimizer
```
###### Note: Training_step defines the training loop. Forward defines how the LightningModule behaves during inference/prediction.
**Note: Training_step defines the training loop. Forward defines how the LightningModule behaves during inference/prediction.**
#### Step 2: Train!
### Step 3: Train!
```python
dataset = MNIST(os.getcwd(), download=True, transform=transforms.ToTensor())