Deprecate`truncated_bptt_steps` flag on Trainer in favor of same setting on the LightningModule #7323

ananthsub · 2021-05-03T04:34:18Z

What does this PR do?

This also fixes an inconsistency between the documentation and code. The documentation said hiddens would be passed only if truncated_bptt_steps > 0, but the code was sending hiddens if truncated_bptt_steps was not None, so if truncated_tbptt_steps = 0, then we'd send hiddens to the lightning module

Before submitting

Was this discussed/approved via a GitHub issue? (not for typos and docs)
Did you read the contributor guideline, Pull Request section?
Did you make sure your PR does only one thing, instead of bundling different changes together?
Did you make sure to update the documentation with your changes? (if necessary)
Did you write any new necessary tests? (not for typos and docs)
Did you verify new and existing tests pass locally with your changes?
Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

Is this pull request ready for review? (if not, please submit in draft mode)
Check that all items from Before submitting are resolved
Make sure the title is self-explanatory and the description concisely explains the PR
Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

codecov · 2021-05-03T04:47:27Z

Codecov Report

Merging #7323 (d1669fd) into master (f135deb) will decrease coverage by 1%.
The diff coverage is 95%.

@@          Coverage Diff           @@
##           master   #7323   +/-   ##
======================================
- Coverage      87%     87%   -1%     
======================================
  Files         200     200           
  Lines       12895   12946   +51     
======================================
- Hits        11259   11237   -22     
- Misses       1636    1709   +73

pep8speaks · 2021-05-03T05:00:15Z

Hello @ananthsub! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-05-04 16:34:32 UTC

pytorch_lightning/core/lightning.py

pytorch_lightning/trainer/training_loop.py

carmocca

Don't we have any docs example where the trainer flag use needs to be updated? Did you try grepping?

pytorch_lightning/trainer/trainer.py

pytorch_lightning/core/lightning.py

ananthsub · 2021-05-04T01:05:00Z

Don't we have any docs example where the trainer flag use needs to be updated? Did you try grepping?

@carmocca updated the docs to reflect setting the property on the LightningModule instead of passing a trainer flag. Anything else that should be done for the trainer docs?

carmocca

My grep powers still show a few more occurrences which we should update:

docs/source/common/trainer.rst:1430:truncated_bptt_steps
docs/source/common/trainer.rst:1436:    poster="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/trainer_flags/thumb/truncated_bptt_steps.jpg"
docs/source/common/trainer.rst:1437:    src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/trainer_flags/truncated_bptt_steps.mp4"></video>
docs/source/common/trainer.rst:1454:    trainer = Trainer(truncated_bptt_steps=None)
docs/source/common/trainer.rst:1457:    trainer = Trainer(truncated_bptt_steps=5)
docs/source/starter/new-project.rst:750:- :ref:`Automatic truncated-back-propagation-through-time <common/trainer:truncated_bptt_steps>`

So we should move these into lightning_module.rst as we do for automatic_optimization.
Not sure if we should keep the video though

cc: @edenlightning ?

docs/source/advanced/sequences.rst

pytorch_lightning/accelerators/accelerator.py

pytorch_lightning/core/lightning.py

pytorch_lightning/trainer/training_loop.py

Borda · 2021-05-04T06:50:15Z

docs/source/common/lightning_module.rst

+.. testcode:: python
+
+    from pytorch_lightning import LightningModule
+
+    class MyModel(LightningModule):
+
+        def __init__(self):
+            super().__init__()
+            # Important: This property activates truncated backpropagation through time
+            # Setting this value to 2 splits the batch into sequences of size 2
+            self.truncated_bptt_steps = 2
+
+        # Truncated back-propagation through time
+        def training_step(self, batch, batch_idx, hiddens):
+            # the training step must be updated to accept a ``hiddens`` argument
+            # hiddens are the hiddens from the previous truncated backprop step
+            out, hiddens = self.lstm(data, hiddens)
+            return {
+                "loss": ...,
+                "hiddens": hiddens
+            }


why exactly the same example as in sequences.rst?

no good reason other than copy/paste. any suggestions on how they should be different?

I may drop the example here and keep only the earlier one...

I would make this short here and link to the "sequences" document which provides all example and tutorials.

docs/source/common/lightning_module.rst

pytorch_lightning/core/lightning.py

pytorch_lightning/trainer/connectors/training_trick_connector.py

pytorch_lightning/trainer/training_loop.py

docs/source/common/lightning_module.rst

pytorch_lightning/core/lightning.py

Borda · 2021-05-05T06:51:48Z

pytorch_lightning/trainer/training_loop.py

@@ -876,11 +877,22 @@ def build_train_args(self, batch, batch_idx, opt_idx, hiddens):
                )

        # pass hiddens if using tbptt
-        if self.trainer.truncated_bptt_steps is not None:
+        if self._truncated_bptt_enabled():


shall this also be a property?

Suggested change

if self._truncated_bptt_enabled():

if self.truncated_bptt_enabled:

Borda · 2021-05-05T06:52:51Z

pytorch_lightning/trainer/training_loop.py

            args.append(hiddens)

        return args

+    def _truncated_bptt_enabled(self) -> bool:


Suggested change

def _truncated_bptt_enabled(self) -> bool:

@property

def truncated_bptt_enabled(self) -> bool:

pytorch_lightning/trainer/training_loop.py

tchaton

LGTM !

ananthsub added the refactor label May 3, 2021

ananthsub added this to the v1.3 milestone May 3, 2021

ananthsub requested review from awaelchli, Borda, carmocca, justusschock, kaushikb11, SeanNaren, tchaton and williamFalcon as code owners May 3, 2021 04:34

ananthsub commented May 3, 2021

View reviewed changes

pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved

ananthsub commented May 3, 2021

View reviewed changes

pytorch_lightning/trainer/training_loop.py Show resolved Hide resolved

carmocca reviewed May 3, 2021

View reviewed changes

pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved

pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved

pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved

pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved

mergify bot added the has conflicts label May 4, 2021

ananthsub requested a review from edenlightning as a code owner May 4, 2021 00:43

mergify bot removed the has conflicts label May 4, 2021

ananthsub added 12 commits May 3, 2021 17:56

deprecate-tbptt-trainer

0dcbb8c

Update CHANGELOG.md

b428df3

Update lightning.py

887028c

test

2152f22

Update lightning.py

03b062e

Update training_loop.py

3d0eb17

Update training_loop.py

fc44fc1

Update lightning.py

e424b2a

Update training_loop.py

1ba38ea

Update training_loop.py

074818d

update docs

020adeb

Update accelerator.py

a6179ae

Update accelerator.py

418cb7e

ananthsub force-pushed the tbptt-prop branch from 50d91a7 to 418cb7e Compare May 4, 2021 00:56

carmocca reviewed May 4, 2021

View reviewed changes

ananthsub and others added 3 commits May 3, 2021 18:32

more docs

597c643

tweaks

d239f99

chlog

148ab33

Borda reviewed May 4, 2021

View reviewed changes

tchaton reviewed May 4, 2021

View reviewed changes

awaelchli added the _Will label May 4, 2021

carmocca reviewed May 4, 2021

View reviewed changes

docs/source/common/lightning_module.rst Outdated Show resolved Hide resolved

docs/source/common/lightning_module.rst Outdated Show resolved Hide resolved

pytorch_lightning/core/lightning.py Show resolved Hide resolved

pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved

comments

d1669fd

carmocca approved these changes May 4, 2021

View reviewed changes

carmocca added the design Includes a design discussion label May 4, 2021

ananthsub changed the title ~~Deprecate truncated_bptt_steps flag on Trainer in favor of same setting on the LightningModule~~ Deprecatetruncated_bptt_steps flag on Trainer in favor of same setting on the LightningModule May 4, 2021

Borda approved these changes May 5, 2021

View reviewed changes

tchaton approved these changes May 5, 2021

View reviewed changes

tchaton merged commit 98670c8 into Lightning-AI:master May 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate`truncated_bptt_steps` flag on Trainer in favor of same setting on the LightningModule #7323

Deprecate`truncated_bptt_steps` flag on Trainer in favor of same setting on the LightningModule #7323

ananthsub commented May 3, 2021 •

edited

Loading

codecov bot commented May 3, 2021 •

edited

Loading

pep8speaks commented May 3, 2021 •

edited

Loading

carmocca left a comment

ananthsub commented May 4, 2021

carmocca left a comment •

edited

Loading

Borda May 4, 2021

ananthsub May 4, 2021

Borda May 5, 2021

awaelchli May 5, 2021

Borda May 5, 2021

Borda May 5, 2021

tchaton left a comment

	if self._truncated_bptt_enabled():
	if self.truncated_bptt_enabled:

	def _truncated_bptt_enabled(self) -> bool:
	@property
	def truncated_bptt_enabled(self) -> bool:

Deprecatetruncated_bptt_steps flag on Trainer in favor of same setting on the LightningModule #7323

Deprecatetruncated_bptt_steps flag on Trainer in favor of same setting on the LightningModule #7323

Conversation

ananthsub commented May 3, 2021 • edited Loading

What does this PR do?

Before submitting

PR review

Did you have fun?

codecov bot commented May 3, 2021 • edited Loading

Codecov Report

pep8speaks commented May 3, 2021 • edited Loading

Comment last updated at 2021-05-04 16:34:32 UTC

carmocca left a comment

Choose a reason for hiding this comment

ananthsub commented May 4, 2021

carmocca left a comment • edited Loading

Choose a reason for hiding this comment

Borda May 4, 2021

Choose a reason for hiding this comment

ananthsub May 4, 2021

Choose a reason for hiding this comment

Borda May 5, 2021

Choose a reason for hiding this comment

awaelchli May 5, 2021

Choose a reason for hiding this comment

Borda May 5, 2021

Choose a reason for hiding this comment

Borda May 5, 2021

Choose a reason for hiding this comment

tchaton left a comment

Choose a reason for hiding this comment

Deprecate`truncated_bptt_steps` flag on Trainer in favor of same setting on the LightningModule #7323

Deprecate`truncated_bptt_steps` flag on Trainer in favor of same setting on the LightningModule #7323

ananthsub commented May 3, 2021 •

edited

Loading

codecov bot commented May 3, 2021 •

edited

Loading

pep8speaks commented May 3, 2021 •

edited

Loading

carmocca left a comment •

edited

Loading