From da8cc0cbaab4d5ad2fffc828f9659e196da035fd Mon Sep 17 00:00:00 2001 From: SkalskiP Date: Wed, 31 Jan 2024 22:24:17 +0100 Subject: [PATCH] documentation updated --- docs/deprecated.md | 1 + pyproject.toml | 2 +- supervision/utils/video.py | 7 ++++++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/deprecated.md b/docs/deprecated.md index b91e14a6..ac60ea37 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -13,3 +13,4 @@ These features are phased out due to better alternatives or potential issues in - `Color.blue()` is deprecated and will be removed in `supervision-0.22.0`. Use `Color.BLUE` instead. - [`ColorPalette.default()`](draw/color.md/#supervision.draw.color.ColorPalette.default) is deprecated and will be removed in `supervision-0.22.0`. Use [`ColorPalette.DEFAULT`](draw/color.md/#supervision.draw.color.ColorPalette.DEFAULT) instead. - `BoxAnnotator` is deprecated and will be removed in `supervision-0.22.0`. Use [`BoundingBoxAnnotator`](annotators.md/#supervision.annotators.core.BoundingBoxAnnotator) and [`LabelAnnotator`](annotators.md/#supervision.annotators.core.LabelAnnotator) instead. +- [`FPSMonitor.__call__`](utils/video.md/#supervision.utils.video.FPSMonitor.__call__) is deprecated and will be removed in `supervision-0.22.0`. Use [`FPSMonitor.fps`](utils/video.md/#supervision.utils.video.FPSMonitor.fps) instead. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 4d5f8bb5..f6557c87 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "supervision" -version = "0.18.0" +version = "0.19.0rc1" description = "A set of easy-to-use utils that will come in handy in any Computer Vision project" authors = ["Piotr Skalski "] maintainers = ["Piotr Skalski "] diff --git a/supervision/utils/video.py b/supervision/utils/video.py index 49e25de7..2c8eb23b 100644 --- a/supervision/utils/video.py +++ b/supervision/utils/video.py @@ -234,10 +234,15 @@ class FPSMonitor: @deprecated( "`FPSMonitor.__call__` is deprecated and will be removed in " - "`supervision-0.21.0`. Use `FPSMonitor.fps` instead." + "`supervision-0.22.0`. Use `FPSMonitor.fps` instead." ) def __call__(self) -> float: """ + !!! failure "Deprecated" + + `FPSMonitor.__call__` is deprecated and will be removed in + `supervision-0.22.0`. Use `FPSMonitor.fps` instead. + Computes and returns the average FPS based on the stored time stamps. Returns: