diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..11bca7a7 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,25 @@ +### 0.3.2 March 23, 2023 + +- Changed [[#50](https://github.com/roboflow/supervision/issues/50)]: Allow `Detections.class_id` to be `None`. + +### 0.3.1 March 6, 2023 + +- Fixed [[#41](https://github.com/roboflow/supervision/issues/41)]: `PolygonZone` throws an exception when the object touches the bottom edge of the image. +- Fixed [[#42](https://github.com/roboflow/supervision/issues/42)]: `Detections.wth_nms` method throws an exception when `Detections` is empty. +- Changed [[#36](https://github.com/roboflow/supervision/pull/36)]: `Detections.wth_nms` support class agnostic and non-class agnostic case. + +### 0.3.0 March 6, 2023 + +- Changed: Allow `Detections.confidence` to be `None`. +- Added: `Detections.from_transformers` and `Detections.from_detectron2` to enable seamless integration with Transformers and Detectron2 models. +- Added: `Detections.area` to dynamically calculate bounding box area. +- Added: `Detections.wth_nms` to filter out double detections with NMS. Initial - only class agnostic - implementation. + +### 0.2.0 February 2, 2023 + +- Added: Advanced `Detections` filtering with pandas-like API. +- Added: `Detections.from_yolov5` and `Detections.from_yolov8` to enable seamless integration with YOLOv5 and YOLOv8 models. + +### 0.1.0 January 19, 2023 + +Say hello to Supervision 👋 diff --git a/docs/draw_utils.md b/docs/draw/utils.md similarity index 100% rename from docs/draw_utils.md rename to docs/draw/utils.md diff --git a/docs/notebook.md b/docs/notebook/utils.md similarity index 100% rename from docs/notebook.md rename to docs/notebook/utils.md diff --git a/mkdocs.yml b/mkdocs.yml index 254e775b..fc71a676 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,13 +30,15 @@ nav: - Annotate: detection/annotate.md - Utils: detection/utils.md - Draw: - - Utils: draw_utils.md - - Notebook: notebook.md + - Utils: draw/utils.md + - Notebook: + - Utils: notebook/utils.md + - Changelog: changelog.md theme: name: 'material' - logo: https://media.roboflow.com/open-source/supervision/supervision-lenny.png?updatedAt=1678995918671 - favicon: https://media.roboflow.com/open-source/supervision/supervision-lenny.png?updatedAt=1678995918671 + logo: https://media.roboflow.com/open-source/supervision/supervision-lenny.png + favicon: https://media.roboflow.com/open-source/supervision/supervision-lenny.png palette: primary: 'deep purple' accent: 'teal' @@ -51,4 +53,6 @@ plugins: markdown_extensions: - admonition - pymdownx.details - - pymdownx.superfences \ No newline at end of file + - pymdownx.superfences + - toc: + permalink: true \ No newline at end of file diff --git a/supervision/notebook/utils.py b/supervision/notebook/utils.py index a750daa1..dce3a00b 100644 --- a/supervision/notebook/utils.py +++ b/supervision/notebook/utils.py @@ -18,10 +18,10 @@ def show_frame_in_notebook( Examples: ```python - >>> from supervision.notebook.utils import show_frame_in_notebook + >>> import supervision as sv %matplotlib inline - show_frame_in_notebook(frame, (16, 16)) + >>> sv.show_frame_in_notebook(frame, (16, 16)) ``` """ if frame.ndim == 2: