Merge pull request #280 from hardikdava/feature/fps

Feature FPS meaure

docs/utils/fps.md

@@ -0,0 +1,3 @@
+## list_files_with_extensions
+
+:::supervision.utils.fps.FpsMonitor

mkdocs.yml

@@ -49,6 +49,7 @@ nav:
       - Image: utils/image.md
       - Notebook: utils/notebook.md
       - File: utils/file.md
+      - FPS: utils/fps.md
   - Changelog: changelog.md
 
 theme:

supervision/__init__.py

@@ -43,6 +43,7 @@
 from supervision.metrics.detection import ConfusionMatrix, MeanAveragePrecision
 from supervision.tracker.byte_tracker.core import ByteTrack
 from supervision.utils.file import list_files_with_extensions
+from supervision.utils.fps import FpsMonitor
 from supervision.utils.image import ImageSink, crop_image
 from supervision.utils.notebook import plot_image, plot_images_grid
 from supervision.utils.video import (

supervision/utils/fps.py

@@ -0,0 +1,34 @@
+import time
+from collections import deque
+
+
+class FpsMonitor:
+    def __init__(self, sample_size: int = 30):
+        """
+        Initialize class to measure Frame per second for latency benchmark.
+        Args:
+            sample_size (int): Maximum observation to measure latency benchmark
+        Examples:
+            ```python
+            >>> import supervision as sv
+
+            >>> fps_monitor = sv.FpsMonitor()
+            >>> while True:
+            ...      (...)
+            ...      fps_monitor.tick()
+            ...      fps = fps_monitor()
+            ```
+        """
+        self.all_timestamps = deque(maxlen=sample_size)
+
+    def __call__(self) -> float:
+        if not self.all_timestamps:
+            return 0.0
+        taken_time = self.all_timestamps[-1] - self.all_timestamps[0]
+        return (len(self.all_timestamps)) / taken_time if taken_time != 0 else 0.0
+
+    def tick(self) -> None:
+        self.all_timestamps.append(time.monotonic())
+
+    def reset(self) -> None:
+        self.all_timestamps.clear()