Skip to content

Conversation

@abhik-99
Copy link
Contributor

@abhik-99 abhik-99 commented Jan 4, 2021

What does this PR do?

There was a typo in Documentation of Code of the compute() function of Recall metric at line 210. It said "Computes accuracy over state." which should have been "Computes recall over state."

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 🙃

There was a typo in Documentation of Code of the ```compute()``` function of ```Recall``` metric at line 210. It said "Computes accuracy over state." which should have been "Computes recall over state."
@codecov
Copy link

codecov bot commented Jan 4, 2021

Codecov Report

Merging #5348 (15e5c70) into master (a40e3a3) will increase coverage by 49%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           master   #5348     +/-   ##
========================================
+ Coverage      44%     93%    +49%     
========================================
  Files         134     134             
  Lines        9838    9950    +112     
========================================
+ Hits         4351    9261   +4910     
+ Misses       5487     689   -4798     

@teddykoker
Copy link
Contributor

Thanks! Good catch :)

@SkafteNicki SkafteNicki added ready PRs ready to be merged docs Documentation related Metrics labels Jan 5, 2021
@SkafteNicki SkafteNicki added this to the 1.1.x milestone Jan 5, 2021
@SkafteNicki SkafteNicki enabled auto-merge (squash) January 5, 2021 09:42
@SkafteNicki SkafteNicki merged commit d568533 into Lightning-AI:master Jan 5, 2021
Borda pushed a commit that referenced this pull request Jan 6, 2021
There was a typo in Documentation of Code of the ```compute()``` function of ```Recall``` metric at line 210. It said "Computes accuracy over state." which should have been "Computes recall over state."

(cherry picked from commit d568533)
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.

4 participants