Add example images for metrics

roboflow · Nov 7, 2024 · 4ed05e7 · 4ed05e7
1 parent 2084f57
commit 4ed05e7
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/supervision/metrics/f1_score.py b/supervision/metrics/f1_score.py
@@ -51,6 +51,10 @@ class F1Score(Metric):
         print(f1_result.f1_50)
         print(f1_result.small_objects.f1_50)
         ```
+
+    ![example_plot](\
+        https://media.roboflow.com/supervision-docs/metrics/f1_plot_example.png\
+        ){ align=center width="800" }
     """
 
     def __init__(

diff --git a/supervision/metrics/mean_average_precision.py b/supervision/metrics/mean_average_precision.py
@@ -46,6 +46,10 @@ class MeanAveragePrecision(Metric):
         print(map_result.map50_95)
         map_result.plot()
         ```
+
+    ![example_plot](\
+        https://media.roboflow.com/supervision-docs/metrics/mAP_plot_example.png\
+        ){ align=center width="800" }
     """
 
     def __init__(

diff --git a/supervision/metrics/precision.py b/supervision/metrics/precision.py
@@ -54,6 +54,10 @@ class Precision(Metric):
         print(precision_result.precision_at_50)
         print(precision_result.small_objects.precision_at_50)
         ```
+
+    ![example_plot](\
+        https://media.roboflow.com/supervision-docs/metrics/precision_plot_example.png\
+        ){ align=center width="800" }
     """
 
     def __init__(

diff --git a/supervision/metrics/recall.py b/supervision/metrics/recall.py
@@ -54,6 +54,10 @@ class Recall(Metric):
         print(recall_result.recall_at_50)
         print(recall_result.small_objects.recall_at_50)
         ```
+
+    ![example_plot](\
+        https://media.roboflow.com/supervision-docs/metrics/recall_plot_example.png\
+        ){ align=center width="800" }
     """
 
     def __init__(