diff --git a/.circleci/config.yml b/.circleci/config.yml index 84e11e7e..582a4f8e 100755 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -32,6 +32,13 @@ references: pip install --editable . ; cd .. & python -c "import pytorch_lightning ; print(pytorch_lightning.__version__)" deactivate ; rm -rf vEnv + create_pkg: &create_pkg + run: + name: Create package + command: | + python setup.py sdist + twine check dist/* + format: &format run: name: Formatting @@ -117,6 +124,7 @@ jobs: - image: circleci/python:3.7 steps: - checkout + - *create_pkg - *install_pkg diff --git a/MANIFEST.in b/MANIFEST.in index f12a637d..a255112e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -25,6 +25,7 @@ exclude tests # Exclude the documentation files recursive-exclude docs * exclude docs +recursive-include docs/source/_static/images/ lightning_logo* pl_overview* tf_* # Include the Requirements include requirements.txt diff --git a/README.md b/README.md index 7aa3b5e6..98f57bbc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- +![Logo](docs/source/_static/images/lightning_logo.svg) # PyTorch Lightning @@ -30,11 +30,11 @@ removed until codecov badge isn't empy. likely a config error showing nothing on | System / PyTorch Version | 1.1 | 1.2 | 1.3 | 1.4 | | :---: | :---: | :---: | :---: | :---: | | Linux py3.6 | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | -| Linux py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) | -| OSX py3.6 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) | -| OSX py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) | -| Windows py3.6 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) | -| Windows py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg) | +| Linux py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | +| OSX py3.6 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | +| OSX py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | +| Windows py3.6 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | +| Windows py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | @@ -65,7 +65,7 @@ To use Lightning, simply refactor your research code into the [LightningModule]( Everything in Blue! This is how lightning separates the science (red) from the engineering (blue). -![Overview](docs/source/_static/images/pl.gif) +![Overview](docs/source/_static/images/pl_overview.gif) ## How much effort is it to convert? You're probably tired of switching frameworks at this point. But it is a very quick process to refactor into the Lightning format (ie: hours). [Check out this tutorial](https://towardsdatascience.com/how-to-refactor-your-pytorch-code-to-get-these-42-benefits-of-pytorch-lighting-6fdd0dc97538) diff --git a/docs/source/_static/images/pl.gif b/docs/source/_static/images/pl_overview.gif similarity index 100% rename from docs/source/_static/images/pl.gif rename to docs/source/_static/images/pl_overview.gif diff --git a/docs/source/_static/images/overview_flat.jpg b/docs/source/_static/images/pl_overview_flat.jpg similarity index 100% rename from docs/source/_static/images/overview_flat.jpg rename to docs/source/_static/images/pl_overview_flat.jpg