From c83b81d5965a89c409f6890e575d156b324ea51c Mon Sep 17 00:00:00 2001 From: William Falcon Date: Fri, 28 Jun 2019 19:00:01 -0400 Subject: [PATCH] added module properties docs --- docs/{ => examples}/Examples.md | 0 docs/index.md | 10 +++++----- mkdocs.yml | 3 ++- 3 files changed, 7 insertions(+), 6 deletions(-) rename docs/{ => examples}/Examples.md (100%) diff --git a/docs/Examples.md b/docs/examples/Examples.md similarity index 100% rename from docs/Examples.md rename to docs/examples/Examples.md diff --git a/docs/index.md b/docs/index.md index f5a9296616..18f492c1ae 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ ###### New project Quick Start To start a new project define these two files. -1. [Define a LightningModule](LightningModule/Examples#template-model-definition) +1. [Define a LightningModule](/LightningModule/RequiredTrainerInterface/#template-model-definition) 2. Pick a trainer - [Basic CPU Trainer](https://github.com/williamFalcon/pytorch-lightning/blob/master/examples/new_project_templates/trainer_cpu_template.py) - [GPU cluster Trainer](https://github.com/williamFalcon/pytorch-lightning/blob/master/examples/new_project_templates/trainer_gpu_cluster_template.py) @@ -13,10 +13,10 @@ To start a new project define these two files. - [Trainer](Trainer/) ###### Quick start examples -- [CPU example](https://williamfalcon.github.io/pytorch-lightning/Examples/#cpu-hyperparameter-search) -- [Hyperparameter search on single GPU](https://williamfalcon.github.io/pytorch-lightning/Examples/#hyperparameter-search-on-a-single-or-multiple-gpus) -- [Hyperparameter search on multiple GPUs on same node](https://williamfalcon.github.io/pytorch-lightning/Examples/#hyperparameter-search-on-a-single-or-multiple-gpus) -- [Hyperparameter search on a SLURM HPC cluster](https://williamfalcon.github.io/pytorch-lightning/Examples/#Hyperparameter search on a SLURM HPC cluster) +- [CPU example](examples/Examples/#cpu-hyperparameter-search) +- [Hyperparameter search on single GPU](examples/Examples/#hyperparameter-search-on-a-single-or-multiple-gpus) +- [Hyperparameter search on multiple GPUs on same node](examples/Examples/#hyperparameter-search-on-a-single-or-multiple-gpus) +- [Hyperparameter search on a SLURM HPC cluster](examples/Examples/#Hyperparameter search on a SLURM HPC cluster) ###### Checkpointing diff --git a/mkdocs.yml b/mkdocs.yml index 585625c993..5675a64e01 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,6 @@ site_name: Pytorch lightning Documentation -theme: readthedocs +theme: + name: 'material' docs_dir: docs repo_url: https://github.com/williamFalcon/pytorch-lightning site_dir: 'site'