Skip to content

Conversation

@lillekemiker
Copy link
Contributor

@lillekemiker lillekemiker commented May 5, 2021

What does this PR do?

This PR addresses a mistake in the documentation and also changes an error message to be more informative.
Specifically, the docs used to state that half precision is available when running on CPU, which is not true.
The exception raised when attempting to do so was a bit cryptic for anyone unfamiliar with the backends used in pytorch. This change should make it clear to the end user that the exception is being raised because they are attempting to use half-precision on CPU and this is not supported.

Fixes issue# N/A (discussed in slack only)

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?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented May 5, 2021

Codecov Report

Merging #7384 (2b420e2) into master (6ad05d3) will decrease coverage by 4%.
The diff coverage is 50%.

@@           Coverage Diff           @@
##           master   #7384    +/-   ##
=======================================
- Coverage      92%     87%    -4%     
=======================================
  Files         200     200            
  Lines       12982   12982            
=======================================
- Hits        11908   11357   -551     
- Misses       1074    1625   +551     

@Borda
Copy link
Collaborator

Borda commented May 5, 2021

@Borda Borda added the docs Documentation related label May 5, 2021
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

thanks for updating my messages :)

made a small commit

LGTM. ready for merge?

@Borda Borda marked this pull request as ready for review May 5, 2021 21:33
@Borda Borda requested a review from carmocca as a code owner May 5, 2021 21:33
@Borda Borda added this to the v1.3 milestone May 5, 2021
@Borda Borda enabled auto-merge (squash) May 6, 2021 08:40
@Borda Borda merged commit c3fc031 into Lightning-AI:master May 6, 2021
@lillekemiker lillekemiker deleted the docs/half_precision_on_cpu branch May 10, 2021 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants