Add note that merge ignores empty detections

2024-06-05 12:28:09 +02:00 · 2024-06-05 12:28:09 +02:00 · ca482967c4
parent 57fa637eea
commit ca482967c4
1 changed files with 4 additions and 0 deletions
--- a/supervision/detection/core.py
+++ b/supervision/detection/core.py
@ -898,6 +898,10 @@ class Detections:
        For example, if merging Detections with 3 and 4 detected objects, this method
        will return a Detections with 7 objects (7 entries in `xyxy`, `mask`, etc).

+        !!! Note
+
+            When merging, empty `Detections` objects are ignored.
+
        Args:
            detections_list (List[Detections]): A list of Detections objects to merge.