Update README.md

This commit is contained in:
William Falcon 2019-03-31 15:39:39 -04:00 committed by GitHub
parent d795d99697
commit 968fbfaacf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 1 deletions

View File

@ -22,6 +22,24 @@ pip install pytorch-lightning
## Docs
In progress. Documenting now!
## What is it?
All you do is define the forward passes, your data and lightning runs everything else for you. BUT, you still keep control over every aspect of training:
1. Running the training loop.
2. Running the validation loop.
3. Running the testing loop.
4. Early stopping.
5. Learning rate annealing.
6. Can train complex models like GANs or anything with multiple optimizers.
7. Weight checkpointing.
8. Model saving.
9. Model loading.
10. Logging training details (through test-tube).
11. Runs training on multiple GPUs (through test-tube).
12. Runs training on a GPU cluster managed by SLURM (through test-tube).
13. Gives your model hyperparameters parsed from the command line OR a JSON file.
14. Runs your model in a dev environment where nothing logs.
## Usage
To use lightning do 2 things:
1. [Define a trainer](https://github.com/williamFalcon/pytorch-lightning/blob/master/pytorch_lightning/trainer_main.py) (which will run ALL your models).