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

[Metrics] [Docs] Add section about device placement #5280

Merged
merged 15 commits into from
Dec 29, 2020

Conversation

SkafteNicki
Copy link
Member

What does this PR do?

Fixes #4909
Adds a section to metrics docs about device placement

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 27, 2020
@SkafteNicki SkafteNicki added this to the 1.1.x milestone Dec 27, 2020
@SkafteNicki SkafteNicki added this to in Progress in Metrics package via automation Dec 27, 2020
@codecov
Copy link

codecov bot commented Dec 27, 2020

Codecov Report

Merging #5280 (d9c8134) into master (0c7c9e8) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5280   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         134     134           
  Lines        9950    9950           
======================================
  Hits         9261    9261           
  Misses        689     689           

Copy link

@Shreeyak Shreeyak left a comment

Choose a reason for hiding this comment

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

Beautiful. Thanks for adding these details. I narrowly avoided using a native dict through luck.

docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
s-rog and others added 3 commits December 28, 2020 14:17
Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>
Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>
Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
docs/source/metrics.rst Outdated Show resolved Hide resolved
Metrics package automation moved this from in Progress to in Review Dec 28, 2020
docs/source/metrics.rst Outdated Show resolved Hide resolved
rohitgr7 and others added 2 commits December 29, 2020 00:38
Co-authored-by: Adrian W盲lchli <aedu.waelchli@gmail.com>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
docs/source/metrics.rst Outdated Show resolved Hide resolved
@rohitgr7 rohitgr7 enabled auto-merge (squash) December 29, 2020 08:19
@rohitgr7 rohitgr7 merged commit dabfeca into Lightning-AI:master Dec 29, 2020
Metrics package automation moved this from in Review to Done Dec 29, 2020
@SkafteNicki SkafteNicki deleted the metric_device branch December 29, 2020 09:13
Borda pushed a commit that referenced this pull request Jan 6, 2021
* update docs

* Update docs/source/metrics.rst

Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>

* Update docs/source/metrics.rst

Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>

* Update docs/source/metrics.rst

Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>

* Update docs/source/metrics.rst

* Update docs/source/metrics.rst

* Update docs/source/metrics.rst

* Apply suggestions from code review

Co-authored-by: Adrian W盲lchli <aedu.waelchli@gmail.com>

* Update docs/source/metrics.rst

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* Update docs/source/metrics.rst

* Update docs/source/metrics.rst

* try fix failing doc test

Co-authored-by: Roger Shieh <sh.rog@protonmail.ch>
Co-authored-by: Shreeyak <shreeyak.sajjan@gmail.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Adrian W盲lchli <aedu.waelchli@gmail.com>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
(cherry picked from commit dabfeca)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

metrics fail if inputs are on gpu
6 participants