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

remove dataloader patching on the LightningModule #9764

Merged
merged 57 commits into from
Oct 20, 2021

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Sep 29, 2021

What does this PR do?

Fixes #6030
Closes #7522

Adds a new mechanism to fetch the dataloader only when it is needed. The previous way was to patch the LightningModule methods with a _PatchDataLoader. While this simplified the code internally for accessing/resetting dataloaders, it also causes problems with Mocking/Testing, debugging in general and silent bugs because the user is not aware that their methods get overridden.

The dataloader patching is nowhere documented. At this point we consider it a silent bug if the patched methods outlive the trainer and continue to be used in subsequent new trainer calls.
However, if someone relies on this weird logic (not sure what the use case would be), their code may break. I currently see no way to deprecate this or inform the user without resulting in false positive messages.

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?

I made sure I had fun coding 🙃

@awaelchli awaelchli added feature Is an improvement or enhancement refactor labels Sep 29, 2021
@awaelchli awaelchli added this to the v1.5 milestone Sep 29, 2021
@awaelchli awaelchli force-pushed the feature/remove-dataloader-patching branch from d30d979 to a10c526 Compare September 29, 2021 15:53
@ananthsub ananthsub added the data handling Generic data-related topic label Sep 30, 2021
@mergify mergify bot added the ready PRs ready to be merged label Oct 14, 2021
@awaelchli awaelchli modified the milestones: v1.5, v1.6 Oct 15, 2021
@awaelchli awaelchli modified the milestones: v1.6, v1.5 Oct 20, 2021
@mergify mergify bot removed the has conflicts label Oct 20, 2021
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

lgtm 🐰

@awaelchli awaelchli enabled auto-merge (squash) October 20, 2021 09:04
@rohitgr7 rohitgr7 self-requested a review October 20, 2021 11:33
@awaelchli awaelchli merged commit 2c16f1d into master Oct 20, 2021
@awaelchli awaelchli deleted the feature/remove-dataloader-patching branch October 20, 2021 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data handling Generic data-related topic feature Is an improvement or enhancement ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Avoid patching LightningModule methods during training
6 participants