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

Describe the behavior with limit_*_batches=1|1.0 #11950

Merged
merged 5 commits into from
Feb 21, 2022

Conversation

carmocca
Copy link
Contributor

@carmocca carmocca commented Feb 16, 2022

What does this PR do?

The behavior for limit_*_batches is wildly different when the user passes 1 vs 1.0. This can be a footgun.
This PR aims to increase transparency by showing a message clarifying the behavior.

In reaction to https://twitter.com/jxmnop/status/1494007900494303243 cc @Borda @jxmorris12

Proposed by @williamFalcon

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • [n/a] 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?
  • [n/a] 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 list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

  • 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

@carmocca carmocca added the feature Is an improvement or enhancement label Feb 16, 2022
@carmocca carmocca added this to the 1.6 milestone Feb 16, 2022
@carmocca carmocca self-assigned this Feb 16, 2022
@jxmorris12
Copy link
Contributor

thank you!!!!!

@carmocca carmocca marked this pull request as ready for review February 17, 2022 00:28
@carmocca carmocca enabled auto-merge (squash) February 17, 2022 14:58
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.

nit:

tests/trainer/flags/test_limit_batches.py Outdated Show resolved Hide resolved
pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Feb 17, 2022
@carmocca carmocca merged commit 3579a30 into master Feb 21, 2022
@carmocca carmocca deleted the feat/limit-batches-info-message branch February 21, 2022 14:12
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 ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants