Skip to content

Automatically check DataModule.has_{setup,teardown,prepare_data} [2/2]#7238

Merged
Borda merged 16 commits intomasterfrom
check-has-setup-teardown-dm
May 11, 2021
Merged

Automatically check DataModule.has_{setup,teardown,prepare_data} [2/2]#7238
Borda merged 16 commits intomasterfrom
check-has-setup-teardown-dm

Conversation

@carmocca
Copy link
Copy Markdown
Contributor

@carmocca carmocca commented Apr 27, 2021 •
edited
Loading

What does this PR do?

This PR automates checking whether the appropriate setup/teardown/prepare_data has been called. The check was only performed by the Trainer. Now it is done by the DataModule itself.

This has implications for the users if they were manually calling these functions themselves, as they will now be a no-op if they had been called already.

# user code:
dm.setup('fit')
...
dm.setup('fit')  # before this PR setup would get called it again, now it is a no-op

Fixes:

Fixes the check when the stage is None. Before it wasn't checking each attribute (has_setup_{fit,validate,test}) but has_setup_None which is not defined.

This PR does NOT fix_ #7286 because to properly resolve it, we need to avoid stage becoming None in the first place.

Note

The changes in this PR are the opposite of those discussed in #7301.

This PR attempts to fix the current design implementation. Not saying we should not change the design itself in the future.

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

  • 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 bug Something isn't working label Apr 27, 2021
@carmocca carmocca added this to the v1.3 milestone Apr 27, 2021
@carmocca carmocca self-assigned this Apr 27, 2021
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2021 •
edited
Loading

Codecov Report

Merging #7238 (fe91797) into master (3ec5420) will decrease coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #7238   +/-   ##
======================================
- Coverage      92%     92%   -0%     
======================================
  Files         199     199           
  Lines       13030   13034    +4     
======================================
- Hits        11967   11955   -12     
- Misses       1063    1079   +16

@carmocca carmocca changed the title Automatically check DataModule.has_{setup,teardown,prepare_data} [WIP] Automatically check DataModule.has_{setup,teardown,prepare_data} Apr 28, 2021
@carmocca carmocca added the data handling Generic data-related topic label Apr 30, 2021
@carmocca carmocca mentioned this pull request Apr 30, 2021
Merged
9 tasks
@carmocca carmocca changed the title [WIP] Automatically check DataModule.has_{setup,teardown,prepare_data} [WIP][Blocked by #7289] Automatically check DataModule.has_{setup,teardown,prepare_data} Apr 30, 2021
@carmocca carmocca changed the title [WIP][Blocked by #7289] Automatically check DataModule.has_{setup,teardown,prepare_data} [Blocked by #7289] Automatically check DataModule.has_{setup,teardown,prepare_data} Apr 30, 2021
@carmocca carmocca changed the title [Blocked by #7289] Automatically check DataModule.has_{setup,teardown,prepare_data} [Blocked by #7289] Automatically check DataModule.has_{setup,teardown,prepare_data} [2/2] Apr 30, 2021
@carmocca carmocca modified the milestones: v1.3, v1.4 May 3, 2021
@carmocca carmocca changed the title [Blocked by #7289] Automatically check DataModule.has_{setup,teardown,prepare_data} [2/2] Automatically check DataModule.has_{setup,teardown,prepare_data} [2/2] May 4, 2021
@carmocca carmocca marked this pull request as ready for review May 4, 2021 10:50
@mergify mergify Bot added the has conflicts label May 4, 2021
carmocca
carmocca commented May 4, 2021
View reviewed changes
Comment thread docs/source/extensions/datamodules.rst Outdated
@mergify mergify Bot removed the has conflicts label May 4, 2021
ananthsub
ananthsub approved these changes May 4, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@ananthsub ananthsub left a comment

Choose a reason for hiding this comment

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

Agreed with the fix for now but I'm in favor of simplifying/deprecating these properties in v1.4

@mergify mergify Bot added the has conflicts label May 6, 2021
awaelchli
awaelchli approved these changes May 7, 2021
View reviewed changes
Comment thread pytorch_lightning/core/datamodule.py Outdated
tchaton
tchaton approved these changes May 10, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM ! @ananthsub I think this is an important feature as preparing a dataset can be costly and shouldn't be done several times.

How do you propose to solve this problem if we remove those properties ?

@mergify mergify Bot removed the has conflicts label May 10, 2021
@carmocca carmocca modified the milestones: v1.4, v1.3.x May 10, 2021
@carmocca carmocca added the ready to be merged PRs ready to be merged label May 10, 2021
@carmocca carmocca mentioned this pull request May 10, 2021
Closed
@Borda Borda merged commit b65ae79 into master May 11, 2021
@Borda Borda deleted the check-has-setup-teardown-dm branch May 11, 2021 08:53
@harupy harupy mentioned this pull request May 12, 2021
Merged
27 tasks
@carmocca carmocca mentioned this pull request May 17, 2021
Closed
edgarriba pushed a commit that referenced this pull request May 18, 2021
@carmocca @awaelchli @edgarriba
Automatically check DataModule.has_{setup,teardown,prepare_data} [2…
25115a1 
…/2] (#7238)

* Automatically check `DataModule.has_{setup,teardown,prepare_data}`

* Use variable

* Spacing

* Docs

* Update CHANGELOG

* Remove `_DataModuleWrapper`

* Add test

* Update docs/source/extensions/datamodules.rst

* Bad merge

* add test for invalid name

* Remove ValueError

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
lexierule pushed a commit that referenced this pull request May 19, 2021
@carmocca @awaelchli @lexierule
Automatically check DataModule.has_{setup,teardown,prepare_data} [2…
2e226d9 
…/2] (#7238)

* Automatically check `DataModule.has_{setup,teardown,prepare_data}`

* Use variable

* Spacing

* Docs

* Update CHANGELOG

* Remove `_DataModuleWrapper`

* Add test

* Update docs/source/extensions/datamodules.rst

* Bad merge

* add test for invalid name

* Remove ValueError

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Borda Borda Borda approved these changes

@tchaton tchaton tchaton approved these changes

@edenlightning edenlightning Awaiting requested review from edenlightning

@justusschock justusschock Awaiting requested review from justusschock justusschock is a code owner

@kaushikb11 kaushikb11 Awaiting requested review from kaushikb11

@SeanNaren SeanNaren Awaiting requested review from SeanNaren

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

+2 more reviewers

@ananthsub ananthsub ananthsub approved these changes

@awaelchli awaelchli awaelchli approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@carmocca carmocca

Labels

bug Something isn't working data handling Generic data-related topic ready to be merged PRs ready to be merged

Projects

None yet

Milestone

pl:1.3.x

Development

Successfully merging this pull request may close these issues.

5 participants

@carmocca @ananthsub @awaelchli @Borda @tchaton