From 1865de1ff8fae62de613a3ae0ed0cf2b97ca6e8e Mon Sep 17 00:00:00 2001 From: Pattarawat Chormai Date: Fri, 1 Nov 2019 12:55:37 +0100 Subject: [PATCH] [WIP] Fix wrong example paths in README.md (#444) * Fix wrong example paths * correct dataloading wrong condition in Readme --- README.md | 4 ++-- docs/Trainer/Distributed training.md | 2 +- docs/examples/Examples.md | 4 ++-- docs/index.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1797c2b217..b91857a725 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ class CoolSystem(pl.LightningModule): @pl.data_loader def test_dataloader(self): # OPTIONAL - return DataLoader(MNIST(os.getcwd(), train=True, download=True, transform=transforms.ToTensor()), batch_size=32) + return DataLoader(MNIST(os.getcwd(), train=False, download=True, transform=transforms.ToTensor()), batch_size=32) ``` 2. Fit with a [trainer](https://williamfalcon.github.io/pytorch-lightning/Trainer/) ```python @@ -340,7 +340,7 @@ Lightning also adds a text column with all the hyperparameters for this experime - [GAN](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples/domain_templates/gan.py) - [MNIST](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples/basic_examples) - [Other projects using Lightning](https://github.com/williamFalcon/pytorch-lightning/network/dependents?package_id=UGFja2FnZS0zNzE3NDU4OTM%3D) -- [Multi-node](https://github.com/williamFalcon/pytorch-lightning/tree/master/examples/multi_node_examples) +- [Multi-node](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples/multi_node_examples) ## Tutorials - [Basic Lightning use](https://towardsdatascience.com/supercharge-your-ai-research-with-pytorch-lightning-337948a99eec) diff --git a/docs/Trainer/Distributed training.md b/docs/Trainer/Distributed training.md index 807bfc2c2b..8592525e29 100644 --- a/docs/Trainer/Distributed training.md +++ b/docs/Trainer/Distributed training.md @@ -208,7 +208,7 @@ Instead of manually building SLURM scripts, you can use the [SlurmCluster object do this for you. The SlurmCluster can also run a grid search if you pass in a [HyperOptArgumentParser](https://williamfalcon.github.io/test-tube/hyperparameter_optimization/HyperOptArgumentParser/). Here is an example where you run a grid search of 9 combinations of hyperparams. -[The full examples are here](https://github.com/williamFalcon/pytorch-lightning/tree/master/examples/new_project_templates/multi_node_examples). +[The full examples are here](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples/new_project_templates/multi_node_examples). ```python # grid search 3 values of learning rate and 3 values of number of layers for your net # this generates 9 experiments (lr=1e-3, layers=16), (lr=1e-3, layers=32), (lr=1e-3, layers=64), ... (lr=1e-1, layers=64) diff --git a/docs/examples/Examples.md b/docs/examples/Examples.md index f7c71365c8..5deda15919 100644 --- a/docs/examples/Examples.md +++ b/docs/examples/Examples.md @@ -1,9 +1,9 @@ ### Template model definition -In 99% of cases you want to just copy [one of the examples](https://github.com/williamFalcon/pytorch-lightning/tree/master/examples) to start a new lightningModule and change the core of what your model is actually trying to do. +In 99% of cases you want to just copy [one of the examples](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples) to start a new lightningModule and change the core of what your model is actually trying to do. ```bash # get a copy of the module template -wget https://raw.githubusercontent.com/williamFalcon/pytorch-lightning/master/examples/new_project_templates/lightning_module_template.py +wget https://raw.githubusercontent.com/williamFalcon/pytorch-lightning/master/pl_examples/new_project_templates/lightning_module_template.py ``` --- diff --git a/docs/index.md b/docs/index.md index 0a8e8cda18..06a76fec23 100644 --- a/docs/index.md +++ b/docs/index.md @@ -60,8 +60,8 @@ Notice a few things about this flow: ###### Templates 1. [MNIST LightningModule](https://williamfalcon.github.io/pytorch-lightning/LightningModule/RequiredTrainerInterface/#minimal-example) 2. [Trainer](https://williamfalcon.github.io/pytorch-lightning/Trainer/) - - [Basic CPU, GPU Trainer Template](https://github.com/williamFalcon/pytorch-lightning/tree/master/examples/basic_examples) - - [GPU cluster Trainer Template](https://github.com/williamFalcon/pytorch-lightning/tree/master/examples/multi_node_examples) + - [Basic CPU, GPU Trainer Template](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples/basic_examples) + - [GPU cluster Trainer Template](https://github.com/williamFalcon/pytorch-lightning/tree/master/pl_examples/multi_node_examples) ###### Docs shortcuts - [LightningModule](LightningModule/RequiredTrainerInterface/)