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

Update DataModule docs following property deprecations #8864

Merged

Conversation

ananthsub
Copy link
Contributor

@ananthsub ananthsub commented Aug 12, 2021

What does this PR do?

Follow up to #8851 (comment)

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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
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?

Make sure you had fun coding 🙃

@ananthsub ananthsub added data handling Generic data-related topic docs Documentation related labels Aug 12, 2021
@codecov
Copy link

codecov bot commented Aug 12, 2021

Codecov Report

Merging #8864 (6d8ccd4) into master (24f0124) will decrease coverage by 4%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #8864    +/-   ##
=======================================
- Coverage      93%     89%    -4%     
=======================================
  Files         169     169            
  Lines       14078   14078            
=======================================
- Hits        13052   12474   -578     
- Misses       1026    1604   +578     

@ananthsub
Copy link
Contributor Author

ananthsub commented Aug 12, 2021

@carmocca - I wasn't sure what to do about these docs that mention dm._has_setup_fit as this is also deprecated, but it's still the current behavior: https://github.com/PyTorchLightning/pytorch-lightning/blob/master/docs/source/extensions/datamodules.rst#setup

@mergify mergify bot added the ready PRs ready to be merged label Aug 12, 2021
@awaelchli awaelchli added this to the v1.5 milestone Aug 12, 2021
@carmocca
Copy link
Contributor

I wasn't sure what to do about these docs that mention dm._has_setup_fit as this is also deprecated, but it's still the current behavior

That's fine. We will just have to remember to update that when the logic is finally changed.

@ananthsub ananthsub merged commit fec4f28 into Lightning-AI:master Aug 12, 2021
@Tshimanga
Copy link
Contributor

@ananthsub sorry for not getting to this sooner 🙏🏽

four4fish pushed a commit to four4fish/pytorch-lightning that referenced this pull request Aug 16, 2021
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 docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants