Skip to content

Rewrite docs landing, install, and evaluate pages + fix evaluation distractor filtering#322

Merged
SkalskiP merged 27 commits intodevelopfrom
docs/rewrite-install-page
Mar 13, 2026
Merged

Rewrite docs landing, install, and evaluate pages + fix evaluation distractor filtering#322
SkalskiP merged 27 commits intodevelopfrom
docs/rewrite-install-page

Conversation

@SkalskiP
Copy link
Collaborator

Summary

  • Rewrite index.md, install.md, and evaluate.md to follow the patterns established in track.md and download.md — concise prose, CLI-first examples, real benchmark output, and consistent section structure.
  • Fix a bug in _prepare_mot_sequence where ground-truth entries with conf=0 (distractors) were not filtered, causing artificially low evaluation scores on MOT17. Also filter tracker entries with id < 0. Results now match TrackEval exactly.
  • Make --source optional in trackers track when --detections is provided and no visual output is requested, enabling frameless tracking for evaluation workflows.
  • Move Guides before Trackers in mkdocs navigation.

SkalskiP and others added 27 commits March 11, 2026 14:54
* fix(eval): implement MOT Challenge distractor preprocessing in evaluator
  Add Hungarian-matching distractor removal to _prepare_mot_sequence,
  matching the MOT Challenge evaluation protocol used by TrackEval.
  Tracker detections overlapping ignored GT regions (conf==0) are now
  removed before scoring, so they are neither penalized as FP nor
  rewarded as TP.

* refactor(eval): extract helpers from _prepare_mot_sequence and improve readability

Break the monolithic `_prepare_mot_sequence` into focused helper functions:
- `_resolve_num_frames`
- `_build_id_mappings`
- `_extract_ground_truth_frame`
- `_extract_tracker_frame`
- `_remove_distractor_matches`
- `_remap_ids`

Replace cryptic abbreviations with descriptive variable names.
Add inline TrackEval source references.
Remove forbidden module-level docstring.
Replace magic numbers with named constants.
Fill in all TODOs in `detection-quality.md` with final prose.
Add a Detection Models section with COCmO benchmarks, tabbed single-sequence
and all-sequences CLI snippets, and updated results with verified Colab
numbers for YOLO26 Nano, RF-DETR Nano, and RF-DETR Medium.
Remove YOLOv11 Nano from the guide.

Drop the IDSW column from eval commands and output blocks across:
- `evaluate.md`
- `index.md`
- `detection-quality.md`

Enable `navigation.footer` in `mkdocs.yml` for Previous/Next page buttons.
Align the footer with the page layout via CSS.
Update the copyright year to 2026.
…y guide

Embed the RF-DETR latency-accuracy chart in the Detection Models section.

Add per-detector tracking videos for MOT17-13 below each CLI snippet in
Run the Experiment.
Link the RF-DETR + Trackers live stream video in `index.md` (below Install)
and `track.md` (below Install, above Quickstart).

Remove BoT-SORT and McByte placeholder rows from the tracking algorithms
table in `index.md`.
…eatures

Replace outdated evaluation numbers with verified MOT17 FRCNN results.

Add:
- Download Datasets section
- Detection Quality section
- Documentation link to trackers.roboflow.com

Move the HF Playground section below Algorithms.

Remove BoT-SORT and McByte placeholder rows from the algorithms table.
Expand the algorithms table with HOTA scores across four benchmarks:
- MOT17
- SportsMOT
- SoccerNet
- DanceTrack

Complete the eval output with all seven MOT17 val sequences using
verified numbers.

Add:
- Dataset table from the download guide
- RF-DETR + Trackers YouTube callout
- Links to docs pages for install, tracking, evaluation, download,
  and tracker comparison

Move the HF Playground section below Algorithms.

Remove BoT-SORT and McByte placeholder rows from the algorithms table.
Move the Algorithms section above Evaluate.

Update the algorithms table:
- Add a Class column with Python class names
- Restore BoT-SORT and McByte as "coming soon"

Remove:
- Interactive command builder reference
- `--output` flag from the download command
Update the algorithms table:
- Add a Description column with one-sentence tracker summaries
- Move "Coming soon" to the description for BoT-SORT and McByte
- Use dashes in metric columns for those rows
- Remove the Class column

Add a link from "Track from Python" to the documentation.

Break the download command into multiple lines for readability.
…docs/rewrite-install-page

# Conflicts:
#	README.md
Update the algorithms table:
- Add a Description column with one-sentence tracker summaries
- Move "Coming soon" to the description for BoT-SORT and McByte
- Use dashes in metric columns for those rows
- Remove the Class column

Add a link from "Track from Python" to the documentation.

Break the download command into multiple lines for readability.
…docs/rewrite-install-page

# Conflicts:
#	README.md
Update the algorithms table:
- Add a Description column with one-sentence tracker summaries
- Move "Coming soon" to the description for BoT-SORT and McByte
- Use dashes in metric columns for those rows
- Remove the Class column

Add a link from "Track from Python" to the documentation.

Break the download command into multiple lines for readability.
@SkalskiP SkalskiP marked this pull request as ready for review March 13, 2026 17:02
@SkalskiP SkalskiP enabled auto-merge (squash) March 13, 2026 17:03
@SkalskiP SkalskiP disabled auto-merge March 13, 2026 17:04
@SkalskiP SkalskiP merged commit 9f22862 into develop Mar 13, 2026
15 checks passed
@SkalskiP SkalskiP deleted the docs/rewrite-install-page branch March 13, 2026 17:04
@SkalskiP SkalskiP mentioned this pull request Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant