From 697704354aacbb9d2a3232f558ebc6fed62e2020 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 13 Dec 2023 13:46:31 +0000 Subject: [PATCH] =?UTF-8?q?fix(pre=5Fcommit):=20=F0=9F=8E=A8=20auto=20form?= =?UTF-8?q?at=20pre-commit=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- examples/count_people_in_zone/README.md | 12 ++++++------ examples/tracking/README.md | 14 +++++++------- examples/traffic_analysis/README.md | 14 +++++++------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/examples/count_people_in_zone/README.md b/examples/count_people_in_zone/README.md index 2703e759..bad984ae 100644 --- a/examples/count_people_in_zone/README.md +++ b/examples/count_people_in_zone/README.md @@ -35,17 +35,17 @@ video or display it live on the screen. ## 🛠️ script arguments -- `--zone_configuration_path`: Specifies the path to the JSON file containing zone -configurations. This file defines the polygonal areas in the video where objects will +- `--zone_configuration_path`: Specifies the path to the JSON file containing zone +configurations. This file defines the polygonal areas in the video where objects will be counted. -- `--source_weights_path` (optional): The path to the YOLO model's weights file. +- `--source_weights_path` (optional): The path to the YOLO model's weights file. Defaults to `"yolov8x.pt"` if not specified. - `--source_video_path`: The path to the source video file that will be analyzed. -- `--target_video_path` (optional): The path to save the output video with annotations. +- `--target_video_path` (optional): The path to save the output video with annotations. If not provided, the processed video will be displayed in real-time. -- `--confidence_threshold` (optional): Sets the confidence threshold for the YOLO model +- `--confidence_threshold` (optional): Sets the confidence threshold for the YOLO model to filter detections. Default is `0.3`. -- `--iou_threshold` (optional): Specifies the IOU (Intersection Over Union) threshold +- `--iou_threshold` (optional): Specifies the IOU (Intersection Over Union) threshold for the model. Default is `0.7`. ## ⚙️ run example diff --git a/examples/tracking/README.md b/examples/tracking/README.md index c1e2c671..f07bd67b 100644 --- a/examples/tracking/README.md +++ b/examples/tracking/README.md @@ -27,18 +27,18 @@ detection and Supervision for tracking and annotation. ## 🛠️ script arguments -- `--source_weights_path`: Required. Specifies the path to the YOLO model's weights -file, which is essential for the object detection process. This file contains the data +- `--source_weights_path`: Required. Specifies the path to the YOLO model's weights +file, which is essential for the object detection process. This file contains the data that the model uses to identify objects in the video. -- `--source_video_path`: Required. The path to the source video file to be processed. +- `--source_video_path`: Required. The path to the source video file to be processed. This is the video on which object detection and annotation will be performed. - `--target_video_path`: Required. The path where the processed video, with annotations added, will be saved. This is your output video file. -- `--confidence_threshold` (optional): Sets the confidence level at which the model -identifies objects in the video. Default is `0.3`. A higher threshold makes the model +- `--confidence_threshold` (optional): Sets the confidence level at which the model +identifies objects in the video. Default is `0.3`. A higher threshold makes the model more selective, while a lower threshold makes it more inclusive in identifying objects. -- `--iou_threshold` (optional): Specifies the IOU (Intersection Over Union) threshold -for the model, defaulting to `0.7`. This parameter helps in differentiating between +- `--iou_threshold` (optional): Specifies the IOU (Intersection Over Union) threshold +for the model, defaulting to `0.7`. This parameter helps in differentiating between distinct objects, especially in crowded scenes. ## ⚙️ run diff --git a/examples/traffic_analysis/README.md b/examples/traffic_analysis/README.md index 9746a561..944213c9 100644 --- a/examples/traffic_analysis/README.md +++ b/examples/traffic_analysis/README.md @@ -33,21 +33,21 @@ https://github.com/roboflow/supervision/assets/26109316/c9436828-9fbf-4c25-ae8c- ```bash ./setup.sh ``` - + ## 🛠️ script arguments -- `--source_weights_path`: Required. Specifies the path to the weights file for the +- `--source_weights_path`: Required. Specifies the path to the weights file for the YOLO model. This file contains the trained model data necessary for object detection. -- `--source_video_path`: Required. The path to the source video file that will be +- `--source_video_path`: Required. The path to the source video file that will be analyzed. This is the input video on which traffic flow analysis will be performed. - `--target_video_path` (optional): The path to save the output video with annotations. -If not specified, the processed video will be displayed in real-time without being +If not specified, the processed video will be displayed in real-time without being saved. - `--confidence_threshold` (optional): Sets the confidence threshold for the YOLO model -to filter detections. Default is `0.3`. This determines how confident the model should +to filter detections. Default is `0.3`. This determines how confident the model should be to recognize an object in the video. -- `--iou_threshold` (optional): Specifies the IOU (Intersection Over Union) threshold -for the model. Default is 0.7. This value is used to manage object detection accuracy, +- `--iou_threshold` (optional): Specifies the IOU (Intersection Over Union) threshold +for the model. Default is 0.7. This value is used to manage object detection accuracy, particularly in distinguishing between different objects. ## ⚙️ run