Skip to content

Commit

Permalink
Fix tbptt docs (Lightning-AI#484)
Browse files Browse the repository at this point in the history
  • Loading branch information
tullie authored and williamFalcon committed Nov 9, 2019
1 parent e22dea2 commit a3f785d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/Trainer/Training Loop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/Trainer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down

0 comments on commit a3f785d

Please sign in to comment.