added docs page

This commit is contained in:
William Falcon 2019-06-26 19:18:41 -04:00
parent b449524c41
commit f65b81feeb
2 changed files with 23 additions and 3 deletions

View File

@ -20,7 +20,7 @@ pip install pytorch-lightning
```
## Docs
In progress. Documenting now!
**[View the docs here](https://williamfalcon.github.io/pytorch-lightning/)**
## Disclaimer
This is a research tool I built for myself internally while doing my PhD. The API is not 100% production quality, but my hope is that by open-sourcing, we can all get it there (I don't have too much time nowadays to write production-level code).

View File

@ -1,2 +1,22 @@
# main page
hello
# PYTORCH-LIGHTNING DOCUMENTATION
###### Quick start
- CPU example
- Single GPU example
- Multi-gpu example
- SLURM cluster example
###### Distributed training
- Single-gpu
- Multi-gpu
- Multi-node
###### Mixed precision training
- 16-bit mixed precision
###### Computing cluster (SLURM)
- Automatic checkpointing
- Automatic saving, loading
- Walltime auto-resubmit