From a3f785dfca6fb83539a52c5129149464672dc07c Mon Sep 17 00:00:00 2001 From: Tullie Murrell Date: Fri, 8 Nov 2019 18:21:36 -0800 Subject: [PATCH] Fix tbptt docs (#484) --- docs/Trainer/Training Loop.md | 4 ++-- docs/Trainer/index.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Trainer/Training Loop.md b/docs/Trainer/Training Loop.md index bc0c83c8..eea434f9 100644 --- a/docs/Trainer/Training Loop.md +++ b/docs/Trainer/Training Loop.md @@ -112,8 +112,8 @@ def training_step(self, batch, batch_nb): ``` --- -#### Truncated Back Propagation Through Time -There are times when multiple backwards passes are needed for each batch. For example, it may save memory to use Truncated Back Propagation Through Time when training RNNs. +#### Truncated Backpropagation Through Time +There are times when multiple backwards passes are needed for each batch. For example, it may save memory to use Truncated Backpropagation Through Time when training RNNs. When this flag is enabled each batch is split into sequences of size truncated_bptt_steps and passed to training_step(...) separately. A default splitting function is provided, however, you can override it for more flexibility. See [tbptt_split_batch](https://williamfalcon.github.io/pytorch-lightning/Trainer/hooks#tbptt_split_batch). diff --git a/docs/Trainer/index.md b/docs/Trainer/index.md index 1c60786c..07c90c6f 100644 --- a/docs/Trainer/index.md +++ b/docs/Trainer/index.md @@ -73,7 +73,7 @@ But of course the fun is in all the advanced things it can do: - [Set how much of the training set to check (1-100%)](https://williamfalcon.github.io/pytorch-lightning/Trainer/Training%20Loop/#set-how-much-of-the-training-set-to-check) - [Step optimizers at arbitrary intervals](https://williamfalcon.github.io/pytorch-lightning/Trainer/hooks/#optimizer_step) - [Packed sequences](https://williamfalcon.github.io/pytorch-lightning/Trainer/Training%20Loop/#packed-sequences-as-inputs) -- [Truncated Back Propagation Through Time](https://williamfalcon.github.io/pytorch-lightning//Training%20Loop/#truncated-back-propation-through-time) +- [Truncated Backpropagation Through Time](https://williamfalcon.github.io/pytorch-lightning/Trainer/Training%20Loop/#truncated-backpropagtion-through-time) **Validation loop**