diff --git a/README.md b/README.md index 7542eeef3a..ca0ba4b0a5 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,21 @@ -
-
-
-
-
- The PyTorch Keras for ML researchers. More control. Less boilerplate. -
+![Logo](./docs/source/_static/lightning_logo_medium.png) - +# PyTorch Lightning +**The PyTorch Keras for ML researchers. More control. Less boilerplate.** + + +[![PyPI Status](https://badge.fury.io/py/pytorch-lightning.svg)](https://badge.fury.io/py/pytorch-lightning) +[![PyPI Status](https://pepy.tech/badge/pytorch-lightning)](https://pepy.tech/project/pytorch-lightning) +[![Build Status](https://travis-ci.org/williamFalcon/pytorch-lightning.svg?branch=master)](https://travis-ci.org/williamFalcon/pytorch-lightning) +[![Build status](https://ci.appveyor.com/api/projects/status/rum89d7hq8l1kfye?svg=true)](https://ci.appveyor.com/project/Borda/pytorch-lightning) +[![codecov](https://codecov.io/gh/Borda/pytorch-lightning/branch/master/graph/badge.svg)](https://codecov.io/gh/Borda/pytorch-lightning) +[![CodeFactor](https://www.codefactor.io/repository/github/borda/pytorch-lightning/badge)](https://www.codefactor.io/repository/github/borda/pytorch-lightning) +[![ReadTheDocs](https://readthedocs.org/projects/pytorch-lightning/badge/?version=latest)](https://pytorch-lightning.readthedocs.io/en/latest) +[![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/williamFalcon/pytorch-lightning/blob/master/LICENSE) + + +Simple installation from PyPI ```bash pip install pytorch-lightning ``` @@ -137,11 +133,7 @@ print('and going to http://localhost:6006 on your browser') Everything in gray! You define the blue parts using the LightningModule interface: -
-
-
-
-
-
-
-
-
-
-
-
-