Information Retrieval (2/5)

[lucadiliello]

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?

Implements Mean Reciprocal Rank for Information Retrieval. More info here.

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]

Codecov Report

Merging #119 (e6fde35) into master (8e87d1b) will increase coverage by 0.05%.
The diff coverage is 100.00%.

❗ Current head e6fde35 differs from pull request most recent head 6ed117c. Consider uploading reports for the commit 6ed117c to get more accurate results

@@            Coverage Diff             @@
##           master     #119      +/-   ##
==========================================
+ Coverage   96.49%   96.54%   +0.05%     
==========================================
  Files         144       74      -70     
  Lines        4560     2316    -2244     
==========================================
- Hits         4400     2236    -2164     
+ Misses        160       80      -80     

Flag	Coverage Δ
Linux	79.18% <83.63%> (+0.10%)	⬆️
Windows	79.18% <83.63%> (+0.10%)	⬆️
cpu	96.54% <100.00%> (+0.18%)	⬆️
gpu	?
macOS	96.54% <100.00%> (+0.18%)	⬆️
pytest	96.54% <100.00%> (+0.05%)	⬆️
python3.6	96.53% <100.00%> (+0.18%)	⬆️
python3.8	95.46% <100.00%> (-0.90%)	⬇️
python3.9	96.54% <100.00%> (?)
torch1.3.1	95.32% <100.00%> (?)
torch1.4.0	95.46% <100.00%> (+0.20%)	⬆️
torch1.8.1	96.54% <100.00%> (+0.18%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
torchmetrics/__init__.py	100.00% <100.00%> (ø)
torchmetrics/functional/__init__.py	100.00% <100.00%> (ø)
torchmetrics/functional/retrieval/__init__.py	100.00% <100.00%> (ø)
...hmetrics/functional/retrieval/average_precision.py	100.00% <100.00%> (+20.00%)	⬆️
...rchmetrics/functional/retrieval/reciprocal_rank.py	100.00% <100.00%> (ø)
torchmetrics/retrieval/__init__.py	100.00% <100.00%> (ø)
torchmetrics/retrieval/mean_average_precision.py	100.00% <100.00%> (ø)
torchmetrics/retrieval/mean_reciprocal_rank.py	100.00% <100.00%> (ø)
torchmetrics/retrieval/retrieval_metric.py	97.87% <100.00%> (-0.13%)	⬇️
torchmetrics/utilities/checks.py	92.57% <100.00%> (+1.01%)	⬆️
... and 74 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8e87d1b...6ed117c. Read the comment docs.

[pep8speaks]

Hello @lucadiliello! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-03-25 20:26:40 UTC

.