|
29 | 29 | class MeanAverageRecall(Metric):
|
30 | 30 | """
|
31 | 31 | Mean Average Recall (mAR) metric for object detection evaluation.
|
32 |
| - It calculates the average recall across different IoU thresholds. |
| 32 | + Calculates the average recall across different IoU thresholds and detection limits. |
| 33 | +
|
| 34 | + The metric evaluates: |
| 35 | + - IoU thresholds from 0.5 to 0.95 with 0.05 step |
| 36 | + - Different maximum detection limits [1, 10, 100] |
| 37 | + - Size-specific evaluation (small, medium, large objects) |
| 38 | +
|
| 39 | + When no detections or targets are present, returns 0.0. |
33 | 40 |
|
34 | 41 | Example:
|
35 | 42 | ```python
|
@@ -309,15 +316,21 @@ class MeanAverageRecallResult:
|
309 | 316 | Defaults to `0.0` when no detections or targets are present.
|
310 | 317 |
|
311 | 318 | Attributes:
|
312 |
| - metric_target (MetricTarget): the type of data used for the metric |
313 |
| - is_class_agnostic (bool): When computing class-agnostic results, class ID is set to `-1` |
314 |
| - mean_average_recall (float): the global mAR score |
315 |
| - ar_per_class (np.ndarray): the average recall scores per class |
316 |
| - matched_classes (np.ndarray): the class IDs of all matched classes |
317 |
| - small_objects (Optional[MeanAverageRecallResult]): the mAR results for small objects |
318 |
| - medium_objects (Optional[MeanAverageRecallResult]): the mAR results for medium objects |
319 |
| - large_objects (Optional[MeanAverageRecallResult]): the mAR results for large objects |
320 |
| - """ # noqa: E501 // docs |
| 319 | + metric_target (MetricTarget): The type of data used for the metric |
| 320 | + (boxes, masks, or oriented bounding boxes) |
| 321 | + is_class_agnostic (bool): When computing class-agnostic results, |
| 322 | + class ID is set to `-1` |
| 323 | + mean_average_recall (float): The global mAR score averaged across classes, |
| 324 | + IoU thresholds, and detection limits |
| 325 | + ar_per_class (np.ndarray): The average recall scores per class |
| 326 | + matched_classes (np.ndarray): The class IDs of all matched classes |
| 327 | + small_objects (Optional[MeanAverageRecallResult]): The mAR results for |
| 328 | + small objects (area < 32²) |
| 329 | + medium_objects (Optional[MeanAverageRecallResult]): The mAR results for |
| 330 | + medium objects (32² ≤ area < 96²) |
| 331 | + large_objects (Optional[MeanAverageRecallResult]): The mAR results for |
| 332 | + large objects (area ≥ 96²) |
| 333 | + """ |
321 | 334 |
|
322 | 335 | metric_target: MetricTarget
|
323 | 336 | is_class_agnostic: bool
|
|
0 commit comments