Skip to content

Commit a0502f6

Browse files
add process for integrating tracker
1 parent f428791 commit a0502f6

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,31 @@ Sometimes the provided environment is missing GPUs, large datasets, or external
186186
- Where practical:
187187
- Use deterministic or seeded behavior for tests/examples.
188188
- Avoid unnecessary heavy computation in unit tests.
189+
190+
## 9. Integrating a New Tracker (Checklist)
191+
192+
1) Implement the tracker
193+
- Add a new module under `boxmot/trackers/<name>/` (e.g., `sfsort.py`).
194+
- Implement a tracker class that subclasses `BaseTracker` and defines `update()`.
195+
196+
2) Register the tracker
197+
- Add the tracker to `TRACKER_MAPPING` in `boxmot/trackers/tracker_zoo.py`.
198+
- Export it in `boxmot/trackers/__init__.py` and `boxmot/__init__.py`.
199+
- Add the tracker name to the `TRACKERS` list in `boxmot/__init__.py`.
200+
201+
3) Add default configuration
202+
- Create `boxmot/configs/trackers/<name>.yaml` with default parameters and tuning ranges.
203+
204+
4) Update docs
205+
- Add a tracker doc page in `docs/trackers/<name>.md`.
206+
- Add the tracker to `mkdocs.yml` nav.
207+
- Mention it in `docs/index.md` and `README.md` where trackers are listed.
208+
209+
5) Update tests
210+
- Register the tracker in `tests/test_config.py` lists so it’s covered by unit tests.
211+
212+
6) Update CI/benchmarks
213+
- Add the tracker name to workflow matrices/lists in `.github/workflows/`.
214+
215+
7) Commit new files
216+
- Ensure new tracker code, config, and docs are staged and pushed.

0 commit comments

Comments
 (0)