📝 Add Examples to utils/metrics.py
#921
Conversation
for more information, see https://pre-commit.ci
shaneahmed
changed the title
utils/metrics.py
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #921 +/- ##
===========================================
- Coverage 99.70% 99.70% -0.01%
===========================================
Files 71 71
Lines 8848 8847 -1
Branches 1154 1154
===========================================
- Hits 8822 8821 -1
Misses 23 23
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Remove redundant line breaks
| Indices of unpaired points in set B. | ||
| Examples: |
There was a problem hiding this comment.
[nitpick] Consider including comments on expected output for the pair_coordinates examples to help users validate the function's behavior.
| """Calculate the F1-score for predicted set of coordinates.""" | ||
| """Calculate the F1-score for predicted set of coordinates. | ||
| Examples: |
There was a problem hiding this comment.
[nitpick] Consider adding a brief note on the expected f1_score value or output format for the f1_detection examples for clarity.
| :class:`float`: | ||
| An estimate of Sørensen-Dice coefficient value. | ||
| Examples: |
There was a problem hiding this comment.
[nitpick] Consider including expected output details in the dice examples to assist users in verifying the Sørensen-Dice coefficient results.
Add examples to utils/metrics.py.