Skip to content

Commit

Permalink
Add explanations for small/medium/large in metric results
Browse files Browse the repository at this point in the history
  • Loading branch information
LinasKo committed Nov 7, 2024
1 parent 19677be commit e4cf743
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions supervision/metrics/f1_score.py
Original file line number Diff line number Diff line change
Expand Up @@ -476,11 +476,11 @@ class F1ScoreResult:
matched_classes (np.ndarray): the class IDs of all matched classes.
Corresponds to the rows of `f1_per_class`.
small_objects (Optional[F1ScoreResult]): the F1 metric results
for small objects.
for small objects (area < 32²).
medium_objects (Optional[F1ScoreResult]): the F1 metric results
for medium objects.
for medium objects (32² ≤ area < 96²).
large_objects (Optional[F1ScoreResult]): the F1 metric results
for large objects.
for large objects (area ≥ 96²).
"""

metric_target: MetricTarget
Expand Down
6 changes: 3 additions & 3 deletions supervision/metrics/mean_average_precision.py
Original file line number Diff line number Diff line change
Expand Up @@ -440,11 +440,11 @@ class and IoU threshold. Shape: `(num_target_classes, num_iou_thresholds)`
matched_classes (np.ndarray): the class IDs of all matched classes.
Corresponds to the rows of `ap_per_class`.
small_objects (Optional[MeanAveragePrecisionResult]): the mAP results
for small objects.
for small objects (area < 32²).
medium_objects (Optional[MeanAveragePrecisionResult]): the mAP results
for medium objects.
for medium objects (32² ≤ area < 96²).
large_objects (Optional[MeanAveragePrecisionResult]): the mAP results
for large objects.
for large objects (area ≥ 96²).
"""

metric_target: MetricTarget
Expand Down
6 changes: 3 additions & 3 deletions supervision/metrics/precision.py
Original file line number Diff line number Diff line change
Expand Up @@ -479,11 +479,11 @@ class PrecisionResult:
matched_classes (np.ndarray): the class IDs of all matched classes.
Corresponds to the rows of `precision_per_class`.
small_objects (Optional[PrecisionResult]): the Precision metric results
for small objects.
for small objects (area < 32²).
medium_objects (Optional[PrecisionResult]): the Precision metric results
for medium objects.
for medium objects (32² ≤ area < 96²).
large_objects (Optional[PrecisionResult]): the Precision metric results
for large objects.
for large objects (area ≥ 96²).
"""

metric_target: MetricTarget
Expand Down
6 changes: 3 additions & 3 deletions supervision/metrics/recall.py
Original file line number Diff line number Diff line change
Expand Up @@ -478,11 +478,11 @@ class RecallResult:
matched_classes (np.ndarray): the class IDs of all matched classes.
Corresponds to the rows of `recall_per_class`.
small_objects (Optional[RecallResult]): the Recall metric results
for small objects.
for small objects (area < 32²).
medium_objects (Optional[RecallResult]): the Recall metric results
for medium objects.
for medium objects (32² ≤ area < 96²).
large_objects (Optional[RecallResult]): the Recall metric results
for large objects.
for large objects (area ≥ 96²).
"""

metric_target: MetricTarget
Expand Down

0 comments on commit e4cf743

Please sign in to comment.