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

[Doc] Fix on_train_batch_end description #4330

Merged
merged 6 commits into from
Oct 26, 2020
Merged

Conversation

amogkam
Copy link
Contributor

@amogkam amogkam commented Oct 24, 2020

What does this PR do?

I believe the outputs arg to on_train_batch_end hook is the result of training_step_end(training_step(x)) not validation_step_end(validation_step(x)). This PR fixes this in the docstring.

Fixes #4329

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • 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? Otherwise, we ask you to create a separate PR for every change.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

  • Is this pull request ready for review? (if not, please submit in draft mode)

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@mergify mergify bot requested a review from a team October 24, 2020 02:46
@awaelchli awaelchli changed the title [Doc] Fix on_train_batch_end description [Doc] Fix on_train_batch_end description [skip ci] Oct 24, 2020
@awaelchli awaelchli added the docs Documentation related label Oct 24, 2020
@awaelchli awaelchli added this to the 1.0.x milestone Oct 24, 2020
@mergify mergify bot requested a review from a team October 24, 2020 03:06
@codecov
Copy link

codecov bot commented Oct 24, 2020

Codecov Report

Merging #4330 into master will increase coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #4330   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         111     111           
  Lines        8085    8063   -22     
======================================
- Hits         7486    7472   -14     
+ Misses        599     591    -8     

@mergify mergify bot requested a review from a team October 24, 2020 10:19
@ydcjeff ydcjeff added the ready PRs ready to be merged label Oct 24, 2020
Copy link
Contributor

@rohitgr7 rohitgr7 left a comment

Choose a reason for hiding this comment

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

pls wait. a few more are there I think

@mergify mergify bot requested a review from a team October 24, 2020 11:07
@rohitgr7
Copy link
Contributor

[skip ci] doesn't work anymore? This PR seems to be running gpu tests.

@awaelchli
Copy link
Contributor

[skip ci] doesn't work anymore? This PR seems to be running gpu tests.

I think it is because I added it retrospectively?

@awaelchli awaelchli changed the title [Doc] Fix on_train_batch_end description [skip ci] [Doc] Fix on_train_batch_end description Oct 24, 2020
@rohitgr7 rohitgr7 merged commit 6abc254 into Lightning-AI:master Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Typo with on_train_batch_end?
6 participants