From 2944be6644d1b79e8370048b98f1cc2e1425076a Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Fri, 26 Apr 2024 17:17:04 +0200 Subject: [PATCH] Add https://youtu.be/uZ7SymQfqKI and track docs updates (#10351) Signed-off-by: Glenn Jocher Co-authored-by: Muhammad Rizwan Munawar --- docs/en/modes/track.md | 8 +++++++ docs/en/reference/data/dataset.md | 8 +++---- docs/en/reference/utils/__init__.md | 16 ++++++++++++-- docs/en/reference/utils/benchmarks.md | 4 ++++ docs/en/tasks/obb.md | 32 ++++++++++++++++++--------- 5 files changed, 52 insertions(+), 16 deletions(-) diff --git a/docs/en/modes/track.md b/docs/en/modes/track.md index 22e9c0ad..22ec51f7 100644 --- a/docs/en/modes/track.md +++ b/docs/en/modes/track.md @@ -56,6 +56,10 @@ The default tracker is BoT-SORT. ## Tracking +!!! Warning "Tracker Threshold Information" + + If object confidence score will be low, i.e lower than [`track_high_thresh`](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/trackers/bytetrack.yaml#L5), then there will be no tracks successfully returned and updated. + To run the tracker on video streams, use a trained Detect, Segment or Pose model such as YOLOv8n, YOLOv8n-seg and YOLOv8n-pose. !!! Example @@ -93,6 +97,10 @@ As can be seen in the above usage, tracking is available for all Detect, Segment ## Configuration +!!! Warning "Tracker Threshold Information" + + If object confidence score will be low, i.e lower than [`track_high_thresh`](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/trackers/bytetrack.yaml#L5), then there will be no tracks successfully returned and updated. + ### Tracking Arguments Tracking configuration shares properties with Predict mode, such as `conf`, `iou`, and `show`. For further configurations, refer to the [Predict](../modes/predict.md#inference-arguments) model page. diff --git a/docs/en/reference/data/dataset.md b/docs/en/reference/data/dataset.md index 7c8a9263..f8ed4711 100644 --- a/docs/en/reference/data/dataset.md +++ b/docs/en/reference/data/dataset.md @@ -15,10 +15,6 @@ keywords: Ultralytics, YOLO, YOLODataset, SemanticDataset, data handling, data m

-## ::: ultralytics.data.dataset.ClassificationDataset - -

- ## ::: ultralytics.data.dataset.YOLOMultiModalDataset

@@ -34,3 +30,7 @@ keywords: Ultralytics, YOLO, YOLODataset, SemanticDataset, data handling, data m ## ::: ultralytics.data.dataset.SemanticDataset

+ +## ::: ultralytics.data.dataset.ClassificationDataset + +

diff --git a/docs/en/reference/utils/__init__.md b/docs/en/reference/utils/__init__.md index fc4c9a79..67592073 100644 --- a/docs/en/reference/utils/__init__.md +++ b/docs/en/reference/utils/__init__.md @@ -63,6 +63,10 @@ keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_lo

+## ::: ultralytics.utils.read_device_model + +

+ ## ::: ultralytics.utils.is_ubuntu

@@ -83,6 +87,14 @@ keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_lo

+## ::: ultralytics.utils.is_raspberrypi + +

+ +## ::: ultralytics.utils.is_jetson + +

+ ## ::: ultralytics.utils.is_online

@@ -103,11 +115,11 @@ keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_lo

-## ::: ultralytics.utils.is_git_dir +## ::: ultralytics.utils.get_git_dir

-## ::: ultralytics.utils.get_git_dir +## ::: ultralytics.utils.is_git_dir

diff --git a/docs/en/reference/utils/benchmarks.md b/docs/en/reference/utils/benchmarks.md index 76d48857..fc75bd22 100644 --- a/docs/en/reference/utils/benchmarks.md +++ b/docs/en/reference/utils/benchmarks.md @@ -11,6 +11,10 @@ keywords: Ultralytics, ProfileModels, benchmarks, model profiling, performance o

+## ::: ultralytics.utils.benchmarks.RF100Benchmark + +

+ ## ::: ultralytics.utils.benchmarks.ProfileModels

diff --git a/docs/en/tasks/obb.md b/docs/en/tasks/obb.md index 04a12a46..117deb4f 100644 --- a/docs/en/tasks/obb.md +++ b/docs/en/tasks/obb.md @@ -18,16 +18,28 @@ The output of an oriented object detector is a set of rotated bounding boxes tha YOLOv8 OBB models use the `-obb` suffix, i.e. `yolov8n-obb.pt` and are pretrained on [DOTAv1](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/DOTAv1.yaml). -

-
- -
- Watch: Object Detection using Ultralytics YOLOv8 Oriented Bounding Boxes (YOLOv8-OBB) -

+ + + + + +
+ +
+ Watch: Object Detection using Ultralytics YOLOv8 Oriented Bounding Boxes (YOLOv8-OBB) + 		+ +
+ Watch: Object Detection with YOLOv8-OBB using Ultralytics HUB +
## Visual Samples