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

Implemented HitRate for IR #576

Merged
merged 6 commits into from
Oct 22, 2021
Merged

Implemented HitRate for IR #576

merged 6 commits into from
Oct 22, 2021

Conversation

lucadiliello
Copy link
Contributor

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 to update the docs?
  • Did you write any new necessary tests?

What does this PR do?

Fixes #571 .

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Oct 21, 2021

Codecov Report

Merging #576 (f4472df) into master (3984ccd) will increase coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #576   +/-   ##
=====================================
  Coverage      95%    95%           
=====================================
  Files         142    144    +2     
  Lines        5004   5033   +29     
=====================================
+ Hits         4759   4788   +29     
  Misses        245    245           

Copy link
Member

@SkafteNicki SkafteNicki left a comment

Choose a reason for hiding this comment

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

Just a few comments, PR already great :]
Remember to add an entry in the changelog.

torchmetrics/retrieval/retrieval_hit_rate.py Outdated Show resolved Hide resolved
torchmetrics/retrieval/retrieval_hit_rate.py Show resolved Hide resolved
torchmetrics/functional/retrieval/hit_rate.py Show resolved Hide resolved
torchmetrics/functional/retrieval/hit_rate.py Outdated Show resolved Hide resolved
@SkafteNicki SkafteNicki added this to the v0.6 milestone Oct 22, 2021
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

LGTM

@mergify mergify bot added the ready label Oct 22, 2021
lucadiliello and others added 2 commits October 22, 2021 15:53
Co-authored-by: Nicki Skafte Detlefsen <skaftenicki@gmail.com>
Co-authored-by: Nicki Skafte Detlefsen <skaftenicki@gmail.com>
@lucadiliello
Copy link
Contributor Author

I've improved the documentation for all the retrieval metrics since many improvements applied also to the other metrics.

@Borda Borda enabled auto-merge (squash) October 22, 2021 14:11
@Borda Borda merged commit ff84cc9 into Lightning-AI:master Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add HitRate for Information Retrieval
3 participants