From 8162fd33f09ff56da9eacdc4de2c6f7341f4d739 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Fri, 13 Sep 2024 11:56:42 +0200 Subject: [PATCH] Update Tracker Docs (#16262) Signed-off-by: UltralyticsAssistant Co-authored-by: UltralyticsAssistant --- docs/en/macros/track-args.md | 18 +++++++++--------- docs/mkdocs_github_authors.yaml | 3 +++ mkdocs.yml | 17 +++++++++++++++-- 3 files changed, 27 insertions(+), 11 deletions(-) diff --git a/docs/en/macros/track-args.md b/docs/en/macros/track-args.md index a6c220e137..2d3a7c8aff 100644 --- a/docs/en/macros/track-args.md +++ b/docs/en/macros/track-args.md @@ -1,9 +1,9 @@ -| Name | Type | Default | Description | -| --------- | ------- | -------------- | ----------------------------------------------------------- | -| `source` | `im0` | `None` | source directory for images or videos | -| `persist` | `bool` | `False` | persisting tracks between frames | -| `tracker` | `str` | `botsort.yaml` | Tracking method 'bytetrack' or 'botsort' | -| `conf` | `float` | `0.3` | Confidence Threshold | -| `iou` | `float` | `0.5` | IOU Threshold | -| `classes` | `list` | `None` | filter results by class, i.e. classes=0, or classes=[0,2,3] | -| `verbose` | `bool` | `True` | Display the object tracking results | +| Argument | Type | Default | Description | +| --------- | ------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `source` | `str` | `None` | Specifies the source directory for images or videos. Supports file paths and URLs. | +| `persist` | `bool` | `False` | Enables persistent tracking of objects between frames, maintaining IDs across video sequences. | +| `tracker` | `str` | `botsort.yaml` | Specifies the tracking algorithm to use, e.g., `bytetrack.yaml` or `botsort.yaml`. | +| `conf` | `float` | `0.3` | Sets the confidence threshold for detections; lower values allow more objects to be tracked but may include false positives. | +| `iou` | `float` | `0.5` | Sets the Intersection over Union (IoU) threshold for filtering overlapping detections. | +| `classes` | `list` | `None` | Filters results by class index. For example, `classes=[0, 2, 3]` only tracks the specified classes. | +| `verbose` | `bool` | `True` | Controls the display of tracking results, providing a visual output of tracked objects. | diff --git a/docs/mkdocs_github_authors.yaml b/docs/mkdocs_github_authors.yaml index a40aa79a22..1607567986 100644 --- a/docs/mkdocs_github_authors.yaml +++ b/docs/mkdocs_github_authors.yaml @@ -19,6 +19,9 @@ 17316848+maianumerosky@users.noreply.github.com: avatar: https://avatars.githubusercontent.com/u/17316848?v=4 username: maianumerosky +32206511+Y-T-G@users.noreply.github.com: + avatar: https://avatars.githubusercontent.com/u/32206511?v=4 + username: Y-T-G 34196005+fcakyon@users.noreply.github.com: avatar: https://avatars.githubusercontent.com/u/34196005?v=4 username: fcakyon diff --git a/mkdocs.yml b/mkdocs.yml index e97b3fc1ab..1ec7c9c22e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -211,8 +211,6 @@ nav: - solutions/index.md - Guides: - guides/index.md - - Explorer: - - datasets/explorer/index.md - Modes: - modes/index.md - Train: modes/train.md @@ -221,6 +219,13 @@ nav: - Export: modes/export.md - Track: modes/track.md - Benchmark: modes/benchmark.md + - Tasks: + - tasks/index.md + - Detect: tasks/detect.md + - Segment: tasks/segment.md + - Classify: tasks/classify.md + - Pose: tasks/pose.md + - OBB: tasks/obb.md - Tasks: - tasks/index.md - Detect: tasks/detect.md @@ -228,6 +233,14 @@ nav: - Classify: tasks/classify.md - Pose: tasks/pose.md - OBB: tasks/obb.md + - Modes: + - modes/index.md + - Train: modes/train.md + - Val: modes/val.md + - Predict: modes/predict.md + - Export: modes/export.md + - Track: modes/track.md + - Benchmark: modes/benchmark.md - Models: - models/index.md - YOLOv3: models/yolov3.md