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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Mention that datamodules can also be used with .test() method #5286

Merged
merged 4 commits into from
Dec 31, 2020

Conversation

SkafteNicki
Copy link
Member

What does this PR do?

Fixes #5265
Adds to docs that datamodules are also supported as a valid way to pass in an external dataloader

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • 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 needed]?
  • Did you write any new necessary tests [no need for typos, docs]?
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

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
  • Check that target branch and milestone are aligned!

Did you have fun?

Make sure you had fun coding 馃檭

@SkafteNicki SkafteNicki added the docs Documentation related label Dec 28, 2020
@SkafteNicki SkafteNicki added this to the 1.1.x milestone Dec 28, 2020
@codecov
Copy link

codecov bot commented Dec 28, 2020

Codecov Report

Merging #5286 (5bd1b72) into master (dd98a60) will decrease coverage by 1%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5286   +/-   ##
======================================
- Coverage      93%     92%   -1%     
======================================
  Files         134     134           
  Lines        9950   10030   +80     
======================================
+ Hits         9261    9267    +6     
- Misses        689     763   +74     

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.

just minor comments

docs/source/test_set.rst Outdated Show resolved Hide resolved
docs/source/test_set.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@s-rog s-rog left a comment

Choose a reason for hiding this comment

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

Just gotta address rohitgr7's comments!

SkafteNicki and others added 2 commits December 29, 2020 10:32
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
@Borda Borda added the ready PRs ready to be merged label Dec 31, 2020
@Borda Borda enabled auto-merge (squash) December 31, 2020 08:08
@Borda Borda merged commit 64163c2 into Lightning-AI:master Dec 31, 2020
@SkafteNicki SkafteNicki deleted the docs_test_datamodule branch December 31, 2020 08:43
Borda pushed a commit that referenced this pull request Jan 6, 2021
#5286)

* docs

* Apply suggestions from code review

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* ref

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
(cherry picked from commit 64163c2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix Test Set doc to include datamodule
4 participants