xiaoxue_admin
/
supervision
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #823 from roboflow/doc/fix-table-of-content-duplicates 

docs(fix): 🐞📝 removal of table of content duplicates
This commit is contained in:
Piotr Skalski 2024-01-31 14:40:03 +01:00 committed by GitHub
parent c44767cc12 840fe2c5d5
commit c692d264ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 189 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
docs/annotators.md
View File

@ -3,6 +3,8 @@ comments: true
status: new
---
# Annotators
=== "BoundingBox"
```python
@ -378,78 +380,116 @@ status: new
</div>
## BoundingBoxAnnotator
<div class="md-typeset">
<h2>BoundingBoxAnnotator</h2>
</div>
:::supervision.annotators.core.BoundingBoxAnnotator
## RoundBoxAnnotator
<div class="md-typeset">
<h2>RoundBoxAnnotator</h2>
</div>
:::supervision.annotators.core.RoundBoxAnnotator
## BoxCornerAnnotator
<div class="md-typeset">
<h2>BoxCornerAnnotator</h2>
</div>
:::supervision.annotators.core.BoxCornerAnnotator
## OrientedBoxAnnotator
<div class="md-typeset">
<h2>OrientedBoxAnnotator</h2>
</div>
:::supervision.annotators.core.OrientedBoxAnnotator
## ColorAnnotator
<div class="md-typeset">
<h2>ColorAnnotator</h2>
</div>
:::supervision.annotators.core.ColorAnnotator
## CircleAnnotator
<div class="md-typeset">
<h2>CircleAnnotator</h2>
</div>
:::supervision.annotators.core.CircleAnnotator
## DotAnnotator
<div class="md-typeset">
<h2>DotAnnotator</h2>
</div>
:::supervision.annotators.core.DotAnnotator
## TriangleAnnotator
<div class="md-typeset">
<h2>TriangleAnnotator</h2>
</div>
:::supervision.annotators.core.TriangleAnnotator
## EllipseAnnotator
<div class="md-typeset">
<h2>EllipseAnnotator</h2>
</div>
:::supervision.annotators.core.EllipseAnnotator
## HaloAnnotator
<div class="md-typeset">
<h2>HaloAnnotator</h2>
</div>
:::supervision.annotators.core.HaloAnnotator
## PercentageBarAnnotator
<div class="md-typeset">
<h2>PercentageBarAnnotator</h2>
</div>
:::supervision.annotators.core.PercentageBarAnnotator
## HeatMapAnnotator
<div class="md-typeset">
<h2>HeatMapAnnotator</h2>
</div>
:::supervision.annotators.core.HeatMapAnnotator
## MaskAnnotator
<div class="md-typeset">
<h2>MaskAnnotator</h2>
</div>
:::supervision.annotators.core.MaskAnnotator
## PolygonAnnotator
<div class="md-typeset">
<h2>PolygonAnnotator</h2>
</div>
:::supervision.annotators.core.PolygonAnnotator
## LabelAnnotator
<div class="md-typeset">
<h2>LabelAnnotator</h2>
</div>
:::supervision.annotators.core.LabelAnnotator
## BlurAnnotator
<div class="md-typeset">
<h2>BlurAnnotator</h2>
</div>
:::supervision.annotators.core.BlurAnnotator
## PixelateAnnotator
<div class="md-typeset">
<h2>PixelateAnnotator</h2>
</div>
:::supervision.annotators.core.PixelateAnnotator
## TraceAnnotator
<div class="md-typeset">
<h2>TraceAnnotator</h2>
</div>
:::supervision.annotators.core.TraceAnnotator
## ColorLookup
<div class="md-typeset">
<h2>ColorLookup</h2>
</div>
:::supervision.annotators.utils.ColorLookup

11
docs/assets.md
View File

@ -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
<div class="md-typeset">
<h2>download_assets</h2>
</div>
:::supervision.assets.downloader.download_assets
## VideoAssets
<div class="md-typeset">
<h2>VideoAssets</h2>
</div>
:::supervision.assets.list.VideoAssets

2
docs/classification/core.md
View File

@ -2,6 +2,6 @@
comments: true
---
## Classifications
# Classifications
:::supervision.classification.core.Classifications

10
docs/datasets.md
View File

@ -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
<div class="md-typeset">
<h2>DetectionDataset</h2>
</div>
:::supervision.dataset.core.DetectionDataset
## ClassificationDataset
<div class="md-typeset">
<h2>ClassificationDataset</h2>
</div>
:::supervision.dataset.core.ClassificationDataset

2
docs/detection/core.md
View File

@ -3,6 +3,6 @@ comments: true
status: new
---
## Detections
# Detections
:::supervision.detection.core.Detections

2
docs/detection/tools/inference_slicer.md
View File

@ -2,6 +2,6 @@
comments: true
---
## InferenceSlicer
# InferenceSlicer
:::supervision.detection.tools.inference_slicer.InferenceSlicer

2
docs/detection/tools/line_zone.md
View File

@ -2,6 +2,6 @@
comments: true
---
## LineZone
# LineZone
:::supervision.detection.line_counter.LineZone

6
docs/detection/tools/polygon_zone.md
View File

@ -2,10 +2,12 @@
comments: true
---
## PolygonZone
# PolygonZone
:::supervision.detection.tools.polygon_zone.PolygonZone
## PolygonZoneAnnotator
<div class="md-typeset">
<h2>PolygonZoneAnnotator</h2>
</div>
:::supervision.detection.tools.polygon_zone.PolygonZoneAnnotator

2
docs/detection/tools/smoother.md
View File

@ -3,6 +3,6 @@ comments: true
status: new
---
## Detection Smoother
# Detection Smoother
:::supervision.detection.tools.smoother.DetectionsSmoother

38
docs/detection/utils.md
View File

@ -2,38 +2,58 @@
comments: true
---
## box_iou_batch
# Detection Utils
<div class="md-typeset">
<h2>box_iou_batch</h2>
</div>
:::supervision.detection.utils.box_iou_batch
## non_max_suppression
<div class="md-typeset">
<h2>non_max_suppression</h2>
</div>
:::supervision.detection.utils.non_max_suppression
## polygon_to_mask
<div class="md-typeset">
<h2>polygon_to_mask</h2>
</div>
:::supervision.detection.utils.polygon_to_mask
## mask_to_xyxy
<div class="md-typeset">
<h2>mask_to_xyxy</h2>
</div>
:::supervision.detection.utils.mask_to_xyxy
## mask_to_polygons
<div class="md-typeset">
<h2>mask_to_polygons</h2>
</div>
:::supervision.detection.utils.mask_to_polygons
## polygon_to_xyxy
<div class="md-typeset">
<h2>polygon_to_xyxy</h2>
</div>
:::supervision.detection.utils.polygon_to_xyxy
## filter_polygons_by_area
<div class="md-typeset">
<h2>filter_polygons_by_area</h2>
</div>
:::supervision.detection.utils.filter_polygons_by_area
## move_boxes
<div class="md-typeset">
<h2>move_boxes</h2>
</div>
:::supervision.detection.utils.move_boxes
## scale_boxes
<div class="md-typeset">
<h2>scale_boxes</h2>
</div>
:::supervision.detection.utils.scale_boxes

6
docs/draw/color.md
View File

@ -2,10 +2,12 @@
comments: true
---
## Color
# Color
:::supervision.draw.color.Color
## ColorPalette
<div class="md-typeset">
<h2>ColorPalette</h2>
</div>
:::supervision.draw.color.ColorPalette

34
docs/draw/utils.md
View File

@ -2,34 +2,52 @@
comments: true
---
## draw_line
# Draw Utils
<div class="md-typeset">
<h2>draw_line</h2>
</div>
:::supervision.draw.utils.draw_line
## draw_rectangle
<div class="md-typeset">
<h2>draw_rectangle</h2>
</div>
:::supervision.draw.utils.draw_rectangle
## draw_filled_rectangle
<div class="md-typeset">
<h2>draw_filled_rectangle</h2>
</div>
:::supervision.draw.utils.draw_filled_rectangle
## draw_polygon
<div class="md-typeset">
<h2>draw_polygon</h2>
</div>
:::supervision.draw.utils.draw_polygon
## draw_text
<div class="md-typeset">
<h2>draw_text</h2>
</div>
:::supervision.draw.utils.draw_text
## draw_image
<div class="md-typeset">
<h2>draw_image</h2>
</div>
:::supervision.draw.utils.draw_image
## calculate_dynamic_font_scale
<div class="md-typeset">
<h2>calculate_dynamic_font_scale</h2>
</div>
:::supervision.draw.utils.calculate_dynamic_text_scale
## calculate_dynamic_line_thickness
<div class="md-typeset">
<h2>calculate_dynamic_line_thickness</h2>
</div>
:::supervision.draw.utils.calculate_dynamic_line_thickness

2
docs/geometry/core.md
View File

@ -2,6 +2,6 @@
comments: true
---
## Position
# Position
:::supervision.geometry.core.Position

2
docs/how_to/detect_and_annotate.md
View File

@ -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

3
docs/how_to/filter_detections.md
View File

@ -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.
</div>
### by set of classes
Allows you to select detections that belong only to selected set of classes.

2
docs/how_to/track_objects.md
View File

@ -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

2
docs/trackers.md
View File

@ -2,6 +2,6 @@
comments: true
---
## ByteTrack
# ByteTrack
:::supervision.tracker.byte_tracker.core.ByteTrack

6
docs/utils/file.md
View File

@ -2,6 +2,10 @@
comments: true
---
## list_files_with_extensions
# File
<div class="md-typeset">
<h2>list_files_with_extensions</h2>
</div>
:::supervision.utils.file.list_files_with_extensions

6
docs/utils/image.md
View File

@ -2,10 +2,12 @@
comments: true
---
## ImageSink
# ImageSink
:::supervision.utils.image.ImageSink
## crop
<div class="md-typeset">
<h2>crop_image</h2>
</div>
:::supervision.utils.image.crop_image

11
docs/utils/notebook.md
View File

@ -2,10 +2,17 @@
comments: true
---
## plot_image
# Notebooks
<div class="md-typeset">
<h2>plot_image</h2>
</div>
:::supervision.utils.notebook.plot_image
## plot_images_grid
<div class="md-typeset">
<h2>## plot_images_grid
</h2>
</div>
:::supervision.utils.notebook.plot_images_grid

22
docs/utils/video.md
View File

@ -2,22 +2,34 @@
comments: true
---
## VideoInfo
# Video
<div class="md-typeset">
<h2>VideoInfo</h2>
</div>
:::supervision.utils.video.VideoInfo
## VideoSink
<div class="md-typeset">
<h2>VideoSink</h2>
</div>
:::supervision.utils.video.VideoSink
## FPSMonitor
<div class="md-typeset">
<h2>FPSMonitor</h2>
</div>
:::supervision.utils.video.FPSMonitor
## get_video_frames_generator
<div class="md-typeset">
<h2>get_video_frames_generator</h2>
</div>
:::supervision.utils.video.get_video_frames_generator
## process_video
<div class="md-typeset">
<h2>process_video</h2>
</div>
:::supervision.utils.video.process_video

4
mkdocs.yml
View File

@ -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