Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add more detail to tbptt example #755

Merged
merged 2 commits into from
Feb 1, 2020

Conversation

jeremyjordan
Copy link
Contributor

What does this PR do?

Addresses confusion in #748 and adds more detail to the docs. No changes to the code.

@williamFalcon
Copy link
Contributor

awesome. could you also add more details to that param in the trainer doc?

@Borda Borda added the feature Is an improvement or enhancement label Jan 31, 2020
@Borda Borda added this to the 0.6.1 milestone Jan 31, 2020
@@ -413,6 +413,10 @@ def __init__(
# backprop every 5 steps in a batch
trainer = Trainer(truncated_bptt_steps=5)

Using this feature requires updating your LightningModule's `training_step()` to include
a `hiddens` arg.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls remove blank lines here and the next continue line shall start with extra space

@williamFalcon williamFalcon merged commit 589815f into Lightning-AI:master Feb 1, 2020
williamFalcon pushed a commit that referenced this pull request Feb 1, 2020
* remove unnecessary pass statements

* use isinstance for type checks

* remove unnecessary else/elif after return

* remove unnecessary return statements

* move doc string to top

* merge isinstance calls

* remove unnecessary else/elif after raise

* use list comprehension

* do not use len without comparison

* add missing shebang

* revert isinstance check back to type

broke tests, because bool is actually subclass of int

* add missing period to doc string

* remove unnecessary pass statements

* use isinstance for type checks

* remove unnecessary else/elif after return

* remove unnecessary return statements

* move doc string to top

* merge isinstance calls

* remove unnecessary else/elif after raise

* use list comprehension

* do not use len without comparison

* add missing shebang

* revert isinstance check back to type

broke tests, because bool is actually subclass of int

* add missing period to doc string

* Fix default ckpt path when logger exists (#771)

* rename logging -> loggers (#767)

* move logging >> loggers

* add warning

* fix tests

* logging alias

* formatting

* formatting

* use isinstance for type checks

* revert isinstance check back to type

broke tests, because bool is actually subclass of int

* add more detail to tbptt example (#755)

* add more detail to tbptt example

* warn user about new arg in training_step

Co-authored-by: Vadim Bereznyuk <kuynzereb@gmail.com>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Is an improvement or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants