From f65b81feeb6321fe785df75f8e24d5f8112f540a Mon Sep 17 00:00:00 2001 From: William Falcon Date: Wed, 26 Jun 2019 19:18:41 -0400 Subject: [PATCH] added docs page --- README.md | 2 +- docs/index.md | 24 ++++++++++++++++++++++-- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 88fcc017ce..3e2dabed00 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/index.md b/docs/index.md index fd3f6ac29e..812ccaf44c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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