Merge pull request #1661 from roboflow/feat/mAR-metric

Mean Average Recall (mAR) metric
roboflow · Nov 7, 2024 · a6e1f03 · a6e1f03
2 parents b9b802e + 0bfcdea
commit a6e1f03
Show file tree

Hide file tree

Showing 7 changed files with 722 additions and 4 deletions.
diff --git a/docs/metrics/f1_score.md b/docs/metrics/f1_score.md
@@ -1,6 +1,5 @@
 ---
 comments: true
-status: new
 ---
 
 # F1 Score

diff --git a/docs/metrics/mean_average_precision.md b/docs/metrics/mean_average_precision.md
@@ -1,6 +1,5 @@
 ---
 comments: true
-status: new
 ---
 
 # Mean Average Precision

diff --git a/docs/metrics/mean_average_recall.md b/docs/metrics/mean_average_recall.md
@@ -0,0 +1,18 @@
+---
+comments: true
+status: new
+---
+
+# Mean Average Recall
+
+<div class="md-typeset">
+    <h2><a href="#supervision.metrics.mean_average_recall.MeanAverageRecall">MeanAverageRecall</a></h2>
+</div>
+
+:::supervision.metrics.mean_average_recall.MeanAverageRecall
+
+<div class="md-typeset">
+    <h2><a href="#supervision.metrics.mean_average_recall.MeanAverageRecallResult">MeanAverageRecallResult</a></h2>
+</div>
+
+:::supervision.metrics.mean_average_recall.MeanAverageRecallResult
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -66,6 +66,7 @@ nav:
           - Utils: datasets/utils.md
       - Metrics:
           - mAP: metrics/mean_average_precision.md
+          - mAR: metrics/mean_average_recall.md
           - Precision: metrics/precision.md
           - Recall: metrics/recall.md
           - F1 Score: metrics/f1_score.md

diff --git a/supervision/metrics/__init__.py b/supervision/metrics/__init__.py
@@ -8,6 +8,10 @@
     MeanAveragePrecision,
     MeanAveragePrecisionResult,
 )
+from supervision.metrics.mean_average_recall import (
+    MeanAverageRecall,
+    MeanAverageRecallResult,
+)
 from supervision.metrics.precision import Precision, PrecisionResult
 from supervision.metrics.recall import Recall, RecallResult
 from supervision.metrics.utils.object_size import (