Documentation fix for Recall and Hit #369
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation contains max rather than min functions. Min functions are used in the implementation.
|
Could also remove nrel variable from the hit function and remove the formula from the documentation as the metric is more concisely explained in its description. |
Removed nrel and documentation formula.
|
Good catch — thank you! |
|
The code change is causing test failures — need to page in my memory of what's happening there to figure out why. |
|
My bad! Ran the test suite on the wrong branch. Fix is coming as soon as tests pass. |
Tests failed because the function must return None when truth is empty.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #369 +/- ##
==========================================
- Coverage 91.01% 91.00% -0.01%
==========================================
Files 40 40
Lines 3127 3125 -2
==========================================
- Hits 2846 2844 -2
Misses 281 281 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation contains max rather than min functions. Min functions are used in the implementation.