From 24d1840ea1c8b6dab615b6d8c1b4913b131ddff8 Mon Sep 17 00:00:00 2001
From: Onuralp SEZER <thunderbirdtr@gmail.com>
Date: Wed, 15 May 2024 18:35:36 +0300
Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20RichLabelAnnotator=20doc?=
 =?UTF-8?q?umentation=20added=20into=20docs=20and=20minor=20var=20fixes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
---
 docs/annotators.md             | 37 ++++++++++++++++++++++++++++++++++
 supervision/__init__.py        |  1 +
 supervision/annotators/core.py |  4 ++--
 3 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/docs/annotators.md b/docs/annotators.md
index e1f4b115..958f2a74 100644
--- a/docs/annotators.md
+++ b/docs/annotators.md
@@ -285,6 +285,37 @@ status: new
 
     </div>
 
+=== "RichLabel"
+
+    ```python
+    import supervision as sv
+
+    image = ...
+    detections = sv.Detections(...)
+
+    labels = [
+        f"{class_name} {confidence:.2f}"
+        for class_name, confidence
+        in zip(detections['class_name'], detections.confidence)
+    ]
+
+    rich_label_annotator = sv.RichLabelAnnotator(
+        font_path=".../font.ttf",
+        text_position=sv.Position.CENTER
+    )
+    annotated_frame = label_annotator.annotate(
+        scene=image.copy(),
+        detections=detections,
+        labels=labels
+    )
+    ```
+
+    <div class="result" markdown>
+
+    ![label-annotator-example](https://media.roboflow.com/supervision-annotator-examples/label-annotator-example-purple.png){ align=center width="800" }
+
+    </div>
+
 === "Crop"
 
     ```python
@@ -492,6 +523,12 @@ status: new
 
 :::supervision.annotators.core.LabelAnnotator
 
+<div class="md-typeset">
+    <h2><a href="#supervision.annotators.core.RichLabelAnnotator">RichLabelAnnotator</a></h2>
+</div>
+
+:::supervision.annotators.core.RichLabelAnnotator
+
 <div class="md-typeset">
     <h2><a href="#supervision.annotators.core.BlurAnnotator">BlurAnnotator</a></h2>
 </div>
diff --git a/supervision/__init__.py b/supervision/__init__.py
index f8e7a832..d2b502b9 100644
--- a/supervision/__init__.py
+++ b/supervision/__init__.py
@@ -18,6 +18,7 @@ from supervision.annotators.core import (
     HaloAnnotator,
     HeatMapAnnotator,
     LabelAnnotator,
+    RichLabelAnnotator,
     MaskAnnotator,
     OrientedBoxAnnotator,
     PercentageBarAnnotator,
diff --git a/supervision/annotators/core.py b/supervision/annotators/core.py
index f2b552cd..75373e33 100644
--- a/supervision/annotators/core.py
+++ b/supervision/annotators/core.py
@@ -1177,7 +1177,7 @@ class RichLabelAnnotator:
 
         Example:
             ```python
-             import supervision as sv
+            import supervision as sv
 
             image = ...
             detections = sv.Detections(...)
@@ -1188,7 +1188,7 @@ class RichLabelAnnotator:
                 in zip(detections['class_name'], detections.confidence)
             ]
 
-            label_annotator = sv.RichLabelAnnotator(font_path="path/to/font.ttf")
+            rich_label_annotator = sv.RichLabelAnnotator(font_path="path/to/font.ttf")
             annotated_frame = label_annotator.annotate(
                 scene=image.copy(),
                 detections=detections,