Skip to content

Commit ec7ec8e

Browse files
committed
[DOCS] Update config tutorial
1 parent 2ba0afd commit ec7ec8e

1 file changed

Lines changed: 7 additions & 12 deletions

File tree

docs/configuration.rst

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,25 @@ The `defaults` list in this file contains the default value for every category.
1616
You can change these defaults either through the commandline.
1717
For example, to change the dataset and the image detector, you could do::
1818

19-
python -m tracklab.main dataset=posetrack18 detect_multiple=openpifpaf
19+
uv run tracklab dataset=sportsmot bbox_detector=yolox
2020

21-
If you want to change a single value inside a category, for example the bbox extension factor::
21+
If you want to change a single value inside a category, for example the number of frames per video::
2222

23-
python -m tracklab.main detect_multiple=openpifpaf "detect_multiple.cfg.bbox.extension_factor=[0.05,0.05,0.05]"
23+
uv run tracklab dataset.nframes=10
2424

25-
This will both change the detector to ``openpifpaf`` and change a parameter inside the openpifpaf configuration.
2625

2726
You can find out which values you can change by looking at the configuration directory or running::
2827

29-
python -m tracklab.main --help
28+
uv run tracklab --help
3029

3130
Thanks to Hydra, we can also run a grid-search (or other kind of hyper-parameter searches). The default grid-search
3231
is activated with the ``-m`` flag, and by passing a comma-separated list of values, either at the category-level
3332
or at the key-level::
3433

35-
python -m tracklab.main -m dataset=posetrack18,posetrack21 detect_multiple=openpifpaf,yolox track.cfg.max_dist=0.2,0.5,0.7
34+
uv run tracklab -m dataset=sportsmot,dancetrack track.cfg.max_dist=0.2,0.5,0.7
3635

37-
This command will run tracking multiple times, to test two datasets, two image-level detectors with three different
38-
tracking hyper-parameters (combining to 12 runs).
39-
40-
.. hint::
41-
42-
The first ``-m`` is a python flag to run a module, while the second ``-m`` is the multirun flag from hydra
36+
This command will run tracking multiple times, to test two datasets, with three different
37+
tracking hyper-parameters (combining to 6 runs).
4338

4439

4540
Configuration directory

0 commit comments

Comments
 (0)