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

Relax on_train_batch_* hook check with dataloader_iter to a warning #16062

Merged
merged 6 commits into from
Jan 4, 2023

Conversation

erhoo82
Copy link
Contributor

@erhoo82 erhoo82 commented Dec 15, 2022

What does this PR do?

This changes the check of using on_train_batch_start and on_train_batch_end hooks with dataloader_iter from assert to warn.

When these hooks are used with dataloader_iter, the batch_idx argument would not match with the training index depending on how often the batch iteration is called per training step. So, this PR intends to raise warning on such behavior and let users use the training batch hooks for extensive use of dataloader_iter.

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

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

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the 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 🙃

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Dec 15, 2022
@awaelchli awaelchli added feature Is an improvement or enhancement community This PR is from the community labels Dec 16, 2022
@awaelchli awaelchli added this to the v1.9 milestone Dec 16, 2022
@Borda Borda requested a review from carmocca December 24, 2022 03:30
@erhoo82
Copy link
Contributor Author

erhoo82 commented Jan 3, 2023

@carmocca
Please help review and merge.

@mergify mergify bot added the ready PRs ready to be merged label Jan 4, 2023
@carmocca carmocca self-assigned this Jan 4, 2023
@carmocca carmocca changed the title Change the check of on_train_batch hooks with dataloader_iter from assert to warn Relax on_train_batch_* hook check with dataloader_iter to a warning Jan 4, 2023
@carmocca carmocca enabled auto-merge (squash) January 4, 2023 22:18
@carmocca carmocca merged commit 3e7c014 into Lightning-AI:master Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community This PR is from the community feature Is an improvement or enhancement pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants