--data args now xxx.yaml for clarity, but .yaml suffix is not needed

Author: mikel-brostrom

.github/workflows/benchmark.yml

@@ -60,7 +60,7 @@ jobs:
         run: |
           source .venv/bin/activate
 
-          if boxmot eval --classes 0 --yolo-model yolox_x_MOT17_ablation.pt --reid-model lmbn_n_duke.pt --tracking-method ${{ matrix.tracker }} --ci --verbose --data MOT17-ablation; then
+          if boxmot eval --classes 0 --yolo-model yolox_x_MOT17_ablation.pt --reid-model lmbn_n_duke.pt --tracking-method ${{ matrix.tracker }} --ci --verbose --data MOT17-ablation.yaml; then
             STATUS="✅"
           else
             STATUS="❌"

AGENTS.md

@@ -135,9 +135,9 @@ PR / task descriptions should include:
 
   # Example invocations (adjust source/paths as available in your env)
   uv run python -m boxmot.engine.cli track --source <path-or-url> ...
-  uv run python -m boxmot.engine.cli generate --data <dataset-path-or-yaml-name> ...
-  uv run python -m boxmot.engine.cli eval --data <dataset-path-or-yaml-name> ...
-  uv run python -m boxmot.engine.cli tune --data <dataset-path-or-yaml-name> ...
+  uv run python -m boxmot.engine.cli generate --data <dataset-path-or-yaml-file.yaml> ...
+  uv run python -m boxmot.engine.cli eval --data <dataset-path-or-yaml-file.yaml> ...
+  uv run python -m boxmot.engine.cli tune --data <dataset-path-or-yaml-file.yaml> ...
   ```
 
 **If tests or commands cannot be run**

README.md

@@ -101,13 +101,13 @@ boxmot track rtdetr_v2_r101vd osnet_x0_25_msmt17 deepocsort --source 0 --show --
 boxmot track yolov8n osnet_x0_25_msmt17 botsort --source video.mp4 --save --show-trajectories --show-lost
 
 # Evaluate on MOT dataset
-boxmot eval yolox_x_MOT17_ablation lmbn_n_duke botsort --data MOT17-ablation
+boxmot eval yolox_x_MOT17_ablation lmbn_n_duke botsort --data MOT17-ablation.yaml
 
 # Evaluate on MOT dataset + GBRC postprocessing
-boxmot eval yolox_x_MOT17_ablation lmbn_n_duke botsort --data MOT17-ablation --postprocessing gbrc
+boxmot eval yolox_x_MOT17_ablation lmbn_n_duke botsort --data MOT17-ablation.yaml --postprocessing gbrc
 
 # Tune ocsort's hyperparameters for visdrone
-boxmot tune yolox_x_dancetrack_ablation lmbn_n_duke ocsort --data visdrone-ablation --n-trials 10
+boxmot tune yolox_x_dancetrack_ablation lmbn_n_duke ocsort --data visdrone-ablation.yaml --n-trials 10
 
 # Export ReID model with dynamic sized input
 boxmot export --weights osnet_x0_25_msmt17.pt --include onnx --include engine dynamic
@@ -274,11 +274,11 @@ Evaluate a combination of detector, tracking method and ReID model on standard M
 
 ```bash
 # reproduce MOT17 README results
-boxmot eval yolox_x_MOT17_ablation lmbn_n_duke boosttrack --data MOT17-ablation --verbose 
+boxmot eval yolox_x_MOT17_ablation lmbn_n_duke boosttrack --data MOT17-ablation.yaml --verbose 
 # MOT20 results
-boxmot eval yolox_x_MOT20_ablation lmbn_n_duke boosttrack --data MOT20-ablation --verbose 
+boxmot eval yolox_x_MOT20_ablation lmbn_n_duke boosttrack --data MOT20-ablation.yaml --verbose 
 # DanceTrack results
-boxmot eval yolox_x_dancetrack_ablation lmbn_n_duke boosttrack --data dancetrack-ablation --verbose 
+boxmot eval yolox_x_dancetrack_ablation lmbn_n_duke boosttrack --data dancetrack-ablation.yaml --verbose 
 # metrics on custom dataset
 boxmot eval yolov8n osnet_x0_25_msmt17 deepocsort --data ./assets/MOT17-mini/train --verbose
 ```

boxmot/engine/cli.py

@@ -166,7 +166,7 @@ def data_option(func):
         '--data',
         type=str,
         required=True,
-        help='dataset yaml name (e.g. MOT17-ablation) or dataset split path',
+        help='dataset yaml filename (e.g. MOT17-ablation.yaml) or dataset split path',
     )(func)
 
 
@@ -303,7 +303,7 @@ def format_help(self, ctx, formatter):
             formatter.write_text("       DETECTOR (optional) YOLO model like yolov8n, yolov9c, yolo11m, yolox_x")
             formatter.write_text("       REID (optional) ReID model like osnet_x0_25_msmt17, mobilenetv2_x1_4")
             formatter.write_text("       TRACKER (optional) is one of [deepocsort, botsort, bytetrack, strongsort, ocsort, hybridsort]")
-            formatter.write_text("       ARGS (optional) 'arg=value' pairs like 'source=0' (track) or 'data=MOT17-ablation' (eval/tune) that override defaults.")
+            formatter.write_text("       ARGS (optional) 'arg=value' pairs like 'source=0' (track) or 'data=MOT17-ablation.yaml' (eval/tune) that override defaults.")
             formatter.write_text("          See all ARGS at https://github.com/mikel-brostrom/boxmot or 'boxmot MODE --help'")
         formatter.write_paragraph()
 
@@ -322,12 +322,12 @@ def format_help(self, ctx, formatter):
 
             formatter.write_text("3. Evaluate on MOT dataset:")
             with formatter.indentation():
-                formatter.write_text("boxmot eval yolov8n osnet_x0_25_msmt17 deepocsort --data MOT17-ablation")
+                formatter.write_text("boxmot eval yolov8n osnet_x0_25_msmt17 deepocsort --data MOT17-ablation.yaml")
             formatter.write_paragraph()
 
             formatter.write_text("4. Tune tracker hyperparameters:")
             with formatter.indentation():
-                formatter.write_text("boxmot tune --data MOT17-ablation --tracking-method deepocsort --n-trials 10")
+                formatter.write_text("boxmot tune --data MOT17-ablation.yaml --tracking-method deepocsort --n-trials 10")
             formatter.write_paragraph()
 
             formatter.write_text("5. Export ReID model:")