diff --git a/docs/annotators.md b/docs/annotators.md index f10944f1..dc82369f 100644 --- a/docs/annotators.md +++ b/docs/annotators.md @@ -3,6 +3,8 @@ comments: true status: new --- +# Annotators + === "BoundingBox" ```python @@ -378,78 +380,116 @@ status: new -## BoundingBoxAnnotator +
+

BoundingBoxAnnotator

+
:::supervision.annotators.core.BoundingBoxAnnotator -## RoundBoxAnnotator +
+

RoundBoxAnnotator

+
:::supervision.annotators.core.RoundBoxAnnotator -## BoxCornerAnnotator +
+

BoxCornerAnnotator

+
:::supervision.annotators.core.BoxCornerAnnotator -## OrientedBoxAnnotator +
+

OrientedBoxAnnotator

+
:::supervision.annotators.core.OrientedBoxAnnotator -## ColorAnnotator +
+

ColorAnnotator

+
:::supervision.annotators.core.ColorAnnotator -## CircleAnnotator +
+

CircleAnnotator

+
:::supervision.annotators.core.CircleAnnotator -## DotAnnotator +
+

DotAnnotator

+
:::supervision.annotators.core.DotAnnotator -## TriangleAnnotator +
+

TriangleAnnotator

+
:::supervision.annotators.core.TriangleAnnotator -## EllipseAnnotator +
+

EllipseAnnotator

+
:::supervision.annotators.core.EllipseAnnotator -## HaloAnnotator +
+

HaloAnnotator

+
:::supervision.annotators.core.HaloAnnotator -## PercentageBarAnnotator +
+

PercentageBarAnnotator

+
:::supervision.annotators.core.PercentageBarAnnotator -## HeatMapAnnotator +
+

HeatMapAnnotator

+
:::supervision.annotators.core.HeatMapAnnotator -## MaskAnnotator +
+

MaskAnnotator

+
:::supervision.annotators.core.MaskAnnotator -## PolygonAnnotator +
+

PolygonAnnotator

+
:::supervision.annotators.core.PolygonAnnotator -## LabelAnnotator +
+

LabelAnnotator

+
:::supervision.annotators.core.LabelAnnotator -## BlurAnnotator +
+

BlurAnnotator

+
:::supervision.annotators.core.BlurAnnotator -## PixelateAnnotator +
+

PixelateAnnotator

+
:::supervision.annotators.core.PixelateAnnotator -## TraceAnnotator +
+

TraceAnnotator

+
:::supervision.annotators.core.TraceAnnotator -## ColorLookup +
+

ColorLookup

+
:::supervision.annotators.utils.ColorLookup diff --git a/docs/assets.md b/docs/assets.md index 311815b4..0cf10316 100644 --- a/docs/assets.md +++ b/docs/assets.md @@ -2,11 +2,14 @@ comments: true --- +# Assets + Supervision offers an assets download utility that allows you to download video files that you can use in your demos. ## install extra + To install the Supervision assets utility, you can use `pip`. This utility is available as an extra within the Supervision package. @@ -16,10 +19,14 @@ as an extra within the Supervision package. pip install supervision[assets] ``` -## download_assets +
+

download_assets

+
:::supervision.assets.downloader.download_assets -## VideoAssets +
+

VideoAssets

+
:::supervision.assets.list.VideoAssets diff --git a/docs/classification/core.md b/docs/classification/core.md index 7307ae04..30298bcf 100644 --- a/docs/classification/core.md +++ b/docs/classification/core.md @@ -2,6 +2,6 @@ comments: true --- -## Classifications +# Classifications :::supervision.classification.core.Classifications diff --git a/docs/datasets.md b/docs/datasets.md index ae9c8ed7..73931515 100644 --- a/docs/datasets.md +++ b/docs/datasets.md @@ -2,15 +2,21 @@ comments: true --- +# Datasets + !!! warning Dataset API is still fluid and may change. If you use Dataset API in your project until further notice, freeze the `supervision` version in your `requirements.txt` or `setup.py`. -## DetectionDataset +
+

DetectionDataset

+
:::supervision.dataset.core.DetectionDataset -## ClassificationDataset +
+

ClassificationDataset

+
:::supervision.dataset.core.ClassificationDataset diff --git a/docs/detection/core.md b/docs/detection/core.md index 94d641e8..475cdae1 100644 --- a/docs/detection/core.md +++ b/docs/detection/core.md @@ -3,6 +3,6 @@ comments: true status: new --- -## Detections +# Detections :::supervision.detection.core.Detections diff --git a/docs/detection/tools/inference_slicer.md b/docs/detection/tools/inference_slicer.md index ad93801f..5d5d08bc 100644 --- a/docs/detection/tools/inference_slicer.md +++ b/docs/detection/tools/inference_slicer.md @@ -2,6 +2,6 @@ comments: true --- -## InferenceSlicer +# InferenceSlicer :::supervision.detection.tools.inference_slicer.InferenceSlicer diff --git a/docs/detection/tools/line_zone.md b/docs/detection/tools/line_zone.md index 0c310267..49961f0f 100644 --- a/docs/detection/tools/line_zone.md +++ b/docs/detection/tools/line_zone.md @@ -2,6 +2,6 @@ comments: true --- -## LineZone +# LineZone :::supervision.detection.line_counter.LineZone diff --git a/docs/detection/tools/polygon_zone.md b/docs/detection/tools/polygon_zone.md index f674707c..b532451b 100644 --- a/docs/detection/tools/polygon_zone.md +++ b/docs/detection/tools/polygon_zone.md @@ -2,10 +2,12 @@ comments: true --- -## PolygonZone +# PolygonZone :::supervision.detection.tools.polygon_zone.PolygonZone -## PolygonZoneAnnotator +
+

PolygonZoneAnnotator

+
:::supervision.detection.tools.polygon_zone.PolygonZoneAnnotator diff --git a/docs/detection/tools/smoother.md b/docs/detection/tools/smoother.md index e19778d3..1573617e 100644 --- a/docs/detection/tools/smoother.md +++ b/docs/detection/tools/smoother.md @@ -3,6 +3,6 @@ comments: true status: new --- -## Detection Smoother +# Detection Smoother :::supervision.detection.tools.smoother.DetectionsSmoother diff --git a/docs/detection/utils.md b/docs/detection/utils.md index 965f2055..54d1f279 100644 --- a/docs/detection/utils.md +++ b/docs/detection/utils.md @@ -2,38 +2,58 @@ comments: true --- -## box_iou_batch +# Detection Utils + +
+

box_iou_batch

+
:::supervision.detection.utils.box_iou_batch -## non_max_suppression +
+

non_max_suppression

+
:::supervision.detection.utils.non_max_suppression -## polygon_to_mask +
+

polygon_to_mask

+
:::supervision.detection.utils.polygon_to_mask -## mask_to_xyxy +
+

mask_to_xyxy

+
:::supervision.detection.utils.mask_to_xyxy -## mask_to_polygons +
+

mask_to_polygons

+
:::supervision.detection.utils.mask_to_polygons -## polygon_to_xyxy +
+

polygon_to_xyxy

+
:::supervision.detection.utils.polygon_to_xyxy -## filter_polygons_by_area +
+

filter_polygons_by_area

+
:::supervision.detection.utils.filter_polygons_by_area -## move_boxes +
+

move_boxes

+
:::supervision.detection.utils.move_boxes -## scale_boxes +
+

scale_boxes

+
:::supervision.detection.utils.scale_boxes diff --git a/docs/draw/color.md b/docs/draw/color.md index 1e4e2a10..c702814a 100644 --- a/docs/draw/color.md +++ b/docs/draw/color.md @@ -2,10 +2,12 @@ comments: true --- -## Color +# Color :::supervision.draw.color.Color -## ColorPalette +
+

ColorPalette

+
:::supervision.draw.color.ColorPalette diff --git a/docs/draw/utils.md b/docs/draw/utils.md index 86ee0a89..ad3e1d6b 100644 --- a/docs/draw/utils.md +++ b/docs/draw/utils.md @@ -2,34 +2,52 @@ comments: true --- -## draw_line +# Draw Utils + +
+

draw_line

+
:::supervision.draw.utils.draw_line -## draw_rectangle +
+

draw_rectangle

+
:::supervision.draw.utils.draw_rectangle -## draw_filled_rectangle +
+

draw_filled_rectangle

+
:::supervision.draw.utils.draw_filled_rectangle -## draw_polygon +
+

draw_polygon

+
:::supervision.draw.utils.draw_polygon -## draw_text +
+

draw_text

+
:::supervision.draw.utils.draw_text -## draw_image +
+

draw_image

+
:::supervision.draw.utils.draw_image -## calculate_dynamic_font_scale +
+

calculate_dynamic_font_scale

+
:::supervision.draw.utils.calculate_dynamic_text_scale -## calculate_dynamic_line_thickness +
+

calculate_dynamic_line_thickness

+
:::supervision.draw.utils.calculate_dynamic_line_thickness diff --git a/docs/geometry/core.md b/docs/geometry/core.md index 6a740706..ca99b626 100644 --- a/docs/geometry/core.md +++ b/docs/geometry/core.md @@ -2,6 +2,6 @@ comments: true --- -## Position +# Position :::supervision.geometry.core.Position diff --git a/docs/how_to/detect_and_annotate.md b/docs/how_to/detect_and_annotate.md index 2537f47c..3255a2ed 100644 --- a/docs/how_to/detect_and_annotate.md +++ b/docs/how_to/detect_and_annotate.md @@ -2,6 +2,8 @@ comments: true --- +# Detect and Annotate + 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 diff --git a/docs/how_to/filter_detections.md b/docs/how_to/filter_detections.md index 63be7d10..64e26618 100644 --- a/docs/how_to/filter_detections.md +++ b/docs/how_to/filter_detections.md @@ -2,6 +2,8 @@ comments: true --- +# Filter Detections + 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. @@ -42,7 +44,6 @@ Allows you to select detections that belong only to one selected class. - ### by set of classes Allows you to select detections that belong only to selected set of classes. diff --git a/docs/how_to/track_objects.md b/docs/how_to/track_objects.md index 80d14e37..cd630af4 100644 --- a/docs/how_to/track_objects.md +++ b/docs/how_to/track_objects.md @@ -2,6 +2,8 @@ comments: true --- +# Track Objects + 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 diff --git a/docs/trackers.md b/docs/trackers.md index 6f3c8918..cb44441f 100644 --- a/docs/trackers.md +++ b/docs/trackers.md @@ -2,6 +2,6 @@ comments: true --- -## ByteTrack +# ByteTrack :::supervision.tracker.byte_tracker.core.ByteTrack diff --git a/docs/utils/file.md b/docs/utils/file.md index c3fcd6b2..aa086d32 100644 --- a/docs/utils/file.md +++ b/docs/utils/file.md @@ -2,6 +2,10 @@ comments: true --- -## list_files_with_extensions +# File + +
+

list_files_with_extensions

+
:::supervision.utils.file.list_files_with_extensions diff --git a/docs/utils/image.md b/docs/utils/image.md index cbe36f08..2bc53786 100644 --- a/docs/utils/image.md +++ b/docs/utils/image.md @@ -2,10 +2,12 @@ comments: true --- -## ImageSink +# ImageSink :::supervision.utils.image.ImageSink -## crop +
+

crop_image

+
:::supervision.utils.image.crop_image diff --git a/docs/utils/notebook.md b/docs/utils/notebook.md index 98b64801..7ab233bf 100644 --- a/docs/utils/notebook.md +++ b/docs/utils/notebook.md @@ -2,10 +2,17 @@ comments: true --- -## plot_image +# Notebooks + +
+

plot_image

+
:::supervision.utils.notebook.plot_image -## plot_images_grid +
+

## plot_images_grid +

+
:::supervision.utils.notebook.plot_images_grid diff --git a/docs/utils/video.md b/docs/utils/video.md index e81c9121..7fa7ed68 100644 --- a/docs/utils/video.md +++ b/docs/utils/video.md @@ -2,22 +2,34 @@ comments: true --- -## VideoInfo +# Video + +
+

VideoInfo

+
:::supervision.utils.video.VideoInfo -## VideoSink +
+

VideoSink

+
:::supervision.utils.video.VideoSink -## FPSMonitor +
+

FPSMonitor

+
:::supervision.utils.video.FPSMonitor -## get_video_frames_generator +
+

get_video_frames_generator

+
:::supervision.utils.video.get_video_frames_generator -## process_video +
+

process_video

+
:::supervision.utils.video.process_video diff --git a/mkdocs.yml b/mkdocs.yml index 371a848b..0c4926c9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,7 @@ site_description: A set of easy-to-use utilities that will come in handy in any repo_name: roboflow/supervision repo_url: https://github.com/roboflow/supervision edit_uri: https://github.com/roboflow/supervision/tree/main/docs -copyright: Roboflow 2023. All rights reserved. +copyright: Roboflow 2024. All rights reserved. extra: social: @@ -15,7 +15,7 @@ extra: link: https://www.youtube.com/roboflow - icon: fontawesome/brands/linkedin link: https://www.linkedin.com/company/roboflow-ai/mycompany/ - - icon: fontawesome/brands/twitter + - icon: fontawesome/brands/x-twitter link: https://twitter.com/roboflow analytics: provider: google