SkalskiP
00e209744f
Descriptions for various attributes and functionalities have been added into LineZone class to aid developers in understanding their behaviour. Also, the trigger function was modified to return two separate boolean arrays - 'crossed_in' and 'crossed_out' to denote objects crossing the line in specific directions. Moreover, Line Zone documentation is added to the side navigation in mkdocs.yml.
96 lines
2.6 KiB
YAML
96 lines
2.6 KiB
YAML
site_name: Supervision
|
|
site_url: https://supervision.roboflow.com/
|
|
site_author: Roboflow
|
|
site_description: A set of easy-to-use utils that will come in handy in any Computer Vision project
|
|
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.
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/roboflow
|
|
- icon: fontawesome/brands/youtube
|
|
link: https://www.youtube.com/roboflow
|
|
- icon: fontawesome/brands/linkedin
|
|
link: https://www.linkedin.com/company/roboflow-ai/mycompany/
|
|
- icon: fontawesome/brands/twitter
|
|
link: https://twitter.com/roboflow
|
|
analytics:
|
|
provider: google
|
|
property: G-P7ZG0Y19G5
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- How to:
|
|
- Detect and Annotate: how_to/detect_and_annotate.md
|
|
- Process Video: how_to/process_video.md
|
|
- Track Objects: how_to/track_objects.md
|
|
- Filter Detections: how_to/filter_detections.md
|
|
- Evaluate Model: how_to/evaluate_model.md
|
|
- API:
|
|
- Classifications:
|
|
- Core: classification/core.md
|
|
- Detections:
|
|
- Core: detection/core.md
|
|
- Utils: detection/utils.md
|
|
- Tools:
|
|
- Line Zone: detection/tools/line_zone.md
|
|
- Polygon Zone: detection/tools/polygon_zone.md
|
|
- Inference Slicer: detection/tools/inference_slicer.md
|
|
- Annotators: annotators.md
|
|
- Trackers: trackers.md
|
|
- Datasets: datasets.md
|
|
- Metrics:
|
|
- Object Detection: metrics/detection.md
|
|
- Draw:
|
|
- Utils: draw/utils.md
|
|
- Utils:
|
|
- Video: utils/video.md
|
|
- Image: utils/image.md
|
|
- Notebook: utils/notebook.md
|
|
- File: utils/file.md
|
|
- Changelog: changelog.md
|
|
|
|
theme:
|
|
name: 'material'
|
|
logo: https://media.roboflow.com/open-source/supervision/supervision-lenny.png
|
|
favicon: https://media.roboflow.com/open-source/supervision/supervision-lenny.png
|
|
palette:
|
|
# Palette for light mode
|
|
- scheme: default
|
|
primary: 'custom'
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
|
|
# Palette toggle for dark mode
|
|
- scheme: slate
|
|
primary: 'custom'
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
font:
|
|
text: Roboto
|
|
code: Roboto Mono
|
|
custom_dir: 'custom_theme'
|
|
|
|
plugins:
|
|
- mkdocstrings
|
|
- search
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- attr_list
|
|
- md_in_html
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- toc:
|
|
permalink: true
|