ready for review

docs/annotators.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 === "BoundingBox"
 
     ```python

docs/assets.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Supervision offers an assets download utility that allows you to download video files
 that you can use in your demos.
 

docs/classification/core.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## Classifications
 
 :::supervision.classification.core.Classifications

docs/datasets.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 !!! warning
 
     Dataset API is still fluid and may change. If you use Dataset API in your project until further notice, freeze the

docs/detection/core.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## Detections
 
 :::supervision.detection.core.Detections

docs/detection/tools/inference_slicer.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## InferenceSlicer
 
 :::supervision.detection.tools.inference_slicer.InferenceSlicer

docs/detection/tools/line_zone.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## LineZone
 
 :::supervision.detection.line_counter.LineZone

docs/detection/tools/polygon_zone.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## PolygonZone
 
 :::supervision.detection.tools.polygon_zone.PolygonZone

docs/detection/utils.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## box_iou_batch
 
 :::supervision.detection.utils.box_iou_batch

docs/draw/color.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## Color
 
 :::supervision.draw.color.Color

docs/draw/utils.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## draw_line
 
 :::supervision.draw.utils.draw_line

docs/geometry/core.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## Position
 
 :::supervision.geometry.core.Position

docs/how_to/detect_and_annotate.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Supervision offers a streamlined solution to effortlessly annotate predictions from a
 range of object detection and segmentation models. This guide demonstrates how to
 execute inference using the YOLOv8 model with either the

docs/how_to/evaluate_model.md

@@ -1 +1,5 @@
+---
+comments: true
+---
+
 🚧 Page under construction.

docs/how_to/filter_detections.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 The advanced filtering capabilities of the `Detections` class offer users a versatile and efficient way to narrow down
 and refine object detections. This section outlines various filtering methods, including filtering by specific class
 or a set of classes, confidence, object area, bounding box area, relative area, box dimensions, and designated zones.

docs/how_to/process_video.md

@@ -1 +1,5 @@
+---
+comments: true
+---
+
 🚧 Page under construction.

docs/how_to/track_objects.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Leverage Supervision's advanced capabilities for enhancing your video analysis by
 seamlessly [tracking](https://supervision.roboflow.com/trackers/) objects recognized by
 a multitude of object detection and segmentation models. This comprehensive guide will

docs/index.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 <div align="center">
   <p>
     <a align="center" href="" target="_blank">

docs/metrics/detection.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 !!! warning
 
     Evaluation API is still fluid and may change. If you use Evaluation API in your project until further notice, freeze the

docs/theme/partials/comments.html

@@ -0,0 +1,51 @@
+{% if page.meta.comments %}
+<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
+
+<!-- Insert Giscus code snippet from https://giscus.app/ here -->
+<script src="https://giscus.app/client.js"
+        data-repo="roboflow/supervision"
+        data-repo-id="R_kgDOIhIiww"
+        data-category="Docs"
+        data-category-id="DIC_kwDOIhIiw84Ccet_"
+        data-mapping="pathname"
+        data-strict="0"
+        data-reactions-enabled="1"
+        data-emit-metadata="1"
+        data-input-position="top"
+        data-theme="preferred_color_scheme"
+        data-lang="en"
+        data-loading="lazy"
+        crossorigin="anonymous"
+        async>
+</script>
+
+<!-- Synchronize Giscus theme with palette -->
+<script>
+    var giscus = document.querySelector("script[src*=giscus]")
+
+    /* Set palette on initial load */
+    var palette = __md_get("__palette")
+    if (palette && typeof palette.color === "object") {
+      var theme = palette.color.scheme === "slate" ? "dark" : "light"
+      giscus.setAttribute("data-theme", theme)
+    }
+
+    /* Register event handlers after documented loaded */
+    document.addEventListener("DOMContentLoaded", function() {
+      var ref = document.querySelector("[data-md-component=palette]")
+      ref.addEventListener("change", function() {
+        var palette = __md_get("__palette")
+        if (palette && typeof palette.color === "object") {
+          var theme = palette.color.scheme === "slate" ? "dark" : "light"
+
+          /* Instruct Giscus to change theme */
+          var frame = document.querySelector(".giscus-frame")
+          frame.contentWindow.postMessage(
+            { giscus: { setConfig: { theme } } },
+            "https://giscus.app"
+          )
+        }
+      })
+    })
+</script>
+{% endif %}

docs/trackers.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## ByteTrack
 
 :::supervision.tracker.byte_tracker.core.ByteTrack

docs/utils/file.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## list_files_with_extensions
 
 :::supervision.utils.file.list_files_with_extensions

docs/utils/image.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## ImageSink
 
 :::supervision.utils.image.ImageSink

docs/utils/notebook.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## plot_image
 
 :::supervision.utils.notebook.plot_image

docs/utils/video.md

@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## VideoInfo
 
 :::supervision.utils.video.VideoInfo

examples/count_people_in_zone/.gitignore

@@ -3,3 +3,11 @@ data/*
 
 # But re-include all .json files
 !data/*.json
+
+*.pt
+*.pth
+*.mp4
+*.mov
+*.png
+*.jpg
+*.jpeg

examples/speed_estimation/.gitignore

@@ -1,2 +1,9 @@
 data/
 venv*/
+*.pt
+*.pth
+*.mp4
+*.mov
+*.png
+*.jpg
+*.jpeg

examples/traffic_analysis/.gitignore

@@ -1,2 +1,9 @@
 data/
 venv/
+*.pt
+*.pth
+*.mp4
+*.mov
+*.png
+*.jpg
+*.jpeg