Include links to example notebooks in docs #199
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SkalskiP
added a commit
that referenced
this pull request
Jan 28, 2026
* added rf detr to readme as first example * readme with preview of rf-detr and changed yolov11 to rfdetr in inference * changed example links * changed rfdetr-base to medium * RFDETRBase to RFDETRMedium and index.md+ reid.md yolov11m-640 to rfdetr-medium * resolve deepsort from trackers * resolve deepsort from docs, tests and dependencies * resolve deepsort from workflows * resolve deepsort from workflows * fix(pre_commit): 🎨 auto format pre-commit hooks * skip pytest when there are no tests * remove deepsort from keywords * build(deps): bump torch from 2.6.0+cu124 to 2.8.0 (#171) Bumps [torch](https://github.com/pytorch/pytorch) from 2.6.0+cu124 to 2.8.0. - [Release notes](https://github.com/pytorch/pytorch/releases) - [Changelog](https://github.com/pytorch/pytorch/blob/main/RELEASE.md) - [Commits](https://github.com/pytorch/pytorch/commits/v2.8.0) --- updated-dependencies: - dependency-name: torch dependency-version: 2.8.0 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump werkzeug from 3.1.3 to 3.1.5 (#173) Bumps [werkzeug](https://github.com/pallets/werkzeug) from 3.1.3 to 3.1.5. - [Release notes](https://github.com/pallets/werkzeug/releases) - [Changelog](https://github.com/pallets/werkzeug/blob/main/CHANGES.rst) - [Commits](pallets/werkzeug@3.1.3...3.1.5) --- updated-dependencies: - dependency-name: werkzeug dependency-version: 3.1.5 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump protobuf from 6.30.2 to 6.31.1 (#172) Bumps [protobuf](https://github.com/protocolbuffers/protobuf) from 6.30.2 to 6.31.1. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Commits](protocolbuffers/protobuf@v6.30.2...v6.31.1) --- updated-dependencies: - dependency-name: protobuf dependency-version: 6.31.1 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Feat/core/bytetrack release (#174) * Added bytetrack without REID * Added lines to install bytetrack and keyword * added docs and type traacker type to sort_utils for using get_iou * fixed spelling mistakes and improved docs * improved doc overview based on Tomasz feedback and fixed pre-commit * added bytetrack to index in mkdocs * renamed high_conf_boxes_threshold to high_conf_det_threshold * build(deps): bump the uv group across 1 directory with 11 updates (#170) --- updated-dependencies: - dependency-name: aiohttp dependency-version: 3.13.3 dependency-type: direct:production dependency-group: uv - dependency-name: uv dependency-version: 0.9.6 dependency-type: direct:development dependency-group: uv - dependency-name: filelock dependency-version: 3.20.3 dependency-type: indirect dependency-group: uv - dependency-name: fonttools dependency-version: 4.60.2 dependency-type: indirect dependency-group: uv - dependency-name: jupyterlab dependency-version: 4.4.8 dependency-type: indirect dependency-group: uv - dependency-name: pillow dependency-version: 11.3.0 dependency-type: indirect dependency-group: uv - dependency-name: pymdown-extensions dependency-version: 10.16.1 dependency-type: indirect dependency-group: uv - dependency-name: requests dependency-version: 2.32.4 dependency-type: indirect dependency-group: uv - dependency-name: tornado dependency-version: '6.5' dependency-type: indirect dependency-group: uv - dependency-name: urllib3 dependency-version: 2.6.3 dependency-type: indirect dependency-group: uv - dependency-name: virtualenv dependency-version: 20.36.1 dependency-type: indirect dependency-group: uv ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump wheel in the uv group across 1 directory (#178) Bumps the uv group with 1 update in the / directory: [wheel](https://github.com/pypa/wheel). Updates `wheel` from 0.45.1 to 0.46.2 - [Release notes](https://github.com/pypa/wheel/releases) - [Changelog](https://github.com/pypa/wheel/blob/main/docs/news.rst) - [Commits](pypa/wheel@0.45.1...0.46.2) --- updated-dependencies: - dependency-name: wheel dependency-version: 0.46.2 dependency-type: direct:development dependency-group: uv ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(pre_commit): ⬆ pre_commit autoupdate (#109) * ⬆️ Bump pypa/gh-action-pypi-publish from 1.12.4 to 1.13.0 Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.12.4 to 1.13.0. - [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases) - [Commits](pypa/gh-action-pypi-publish@76f52bc...ed0c539) --- updated-dependencies: - dependency-name: pypa/gh-action-pypi-publish dependency-version: 1.13.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(pre_commit): ⬆ pre_commit autoupdate updates: - [github.com/pre-commit/pre-commit-hooks: v5.0.0 → v6.0.0](pre-commit/pre-commit-hooks@v5.0.0...v6.0.0) - [github.com/PyCQA/bandit: 1.8.6 → 1.9.3](PyCQA/bandit@1.8.6...1.9.3) - [github.com/astral-sh/ruff-pre-commit: v0.12.2 → v0.14.13](astral-sh/ruff-pre-commit@v0.12.2...v0.14.13) - [github.com/pre-commit/mirrors-mypy: v1.16.1 → v1.19.1](pre-commit/mirrors-mypy@v1.16.1...v1.19.1) * Update .pre-commit-config.yaml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Piotr Skalski <piotr.skalski92@gmail.com> Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com> * ⬆️ Bump torchvision from 0.21.0+cu124 to 0.23.0 (#131) Bumps [torchvision](https://github.com/pytorch/vision) from 0.21.0+cu124 to 0.23.0. - [Release notes](https://github.com/pytorch/vision/releases) - [Commits](https://github.com/pytorch/vision/commits/0.23.0) --- updated-dependencies: - dependency-name: torchvision dependency-version: 0.23.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ⬆️ Bump torch from 2.6.0+cu124 to 2.8.0 (#130) Bumps [torch](https://github.com/pytorch/pytorch) from 2.6.0+cu124 to 2.8.0. - [Release notes](https://github.com/pytorch/pytorch/releases) - [Changelog](https://github.com/pytorch/pytorch/blob/main/RELEASE.md) - [Commits](https://github.com/pytorch/pytorch/commits/v2.8.0) --- updated-dependencies: - dependency-name: torch dependency-version: 2.8.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Chore Dependabot schedule and grouping (#175) * 🔄 Bump the github-actions group with 3 updates (#179) Bumps the github-actions group with 3 updates: [actions/checkout](https://github.com/actions/checkout), [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) and [actions/create-github-app-token](https://github.com/actions/create-github-app-token). Updates `actions/checkout` from 4.2.2 to 6.0.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@11bd719...de0fac2) Updates `astral-sh/setup-uv` from 6.3.1 to 7.2.0 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](astral-sh/setup-uv@bd01e18...61cb8a9) Updates `actions/create-github-app-token` from 2.0.6 to 2.2.1 - [Release notes](https://github.com/actions/create-github-app-token/releases) - [Commits](actions/create-github-app-token@df432ce...29824e6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.2 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: astral-sh/setup-uv dependency-version: 7.2.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: actions/create-github-app-token dependency-version: 2.2.1 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ⬆️ Bump numpy from 2.2.5 to 2.2.6 (#180) Bumps [numpy](https://github.com/numpy/numpy) from 2.2.5 to 2.2.6. - [Release notes](https://github.com/numpy/numpy/releases) - [Changelog](https://github.com/numpy/numpy/blob/main/doc/RELEASE_WALKTHROUGH.rst) - [Commits](numpy/numpy@v2.2.5...v2.2.6) --- updated-dependencies: - dependency-name: numpy dependency-version: 2.2.6 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ⬆️ Bump supervision from 0.27.0rc0 to 0.28.0rc0 (#181) Bumps [supervision](https://github.com/roboflow/supervision) from 0.27.0rc0 to 0.28.0rc0. - [Release notes](https://github.com/roboflow/supervision/releases) - [Changelog](https://github.com/roboflow/supervision/blob/develop/docs/changelog.md) - [Commits](roboflow/supervision@0.27.0rc0...0.28.0rc0) --- updated-dependencies: - dependency-name: supervision dependency-version: 0.28.0rc0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ⬆️ Bump pytest from 8.3.5 to 9.0.2 (#182) Bumps [pytest](https://github.com/pytest-dev/pytest) from 8.3.5 to 9.0.2. - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst) - [Commits](pytest-dev/pytest@8.3.5...9.0.2) --- updated-dependencies: - dependency-name: pytest dependency-version: 9.0.2 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ⬆️ Bump types-tqdm from 4.67.0.20250513 to 4.67.0.20250809 (#183) Bumps [types-tqdm](https://github.com/typeshed-internal/stub_uploader) from 4.67.0.20250513 to 4.67.0.20250809. - [Commits](https://github.com/typeshed-internal/stub_uploader/commits) --- updated-dependencies: - dependency-name: types-tqdm dependency-version: 4.67.0.20250809 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Remove unused `exclude` rules from pre-commit hooks and simplify ruff arguments (#185) * Update configurations: set Python target version to 3.10 and drop 3.9 from tox envs (#186) * Update linting, testing, and build configurations (#187) * Migrate security rules to Ruff's S [bandit] (#188) * Simplify GitHub workflow tag patterns and rename workflows for clarity (#189) * Simplify GitHub workflow tag patterns and rename workflows for clarity * Fix GitHub workflow tag patterns to correctly match pre-release versions * Add evaluation metrics (benchmarks) to SORT and ByteTrack in README and docs. (#176) * chore(pre_commit): ⬆ pre_commit autoupdate (#191) updates: - [github.com/astral-sh/ruff-pre-commit: v0.14.13 → v0.14.14](astral-sh/ruff-pre-commit@v0.14.13...v0.14.14) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com> * trim dependencies + install docs update (#192) * initial commit * fix(pre_commit): 🎨 auto format pre-commit hooks * clean up pyproject.toml --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Simplify GH Actions workflows for docs (#190) * Update .github/workflows/publish-docs.yml --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * benchmarks documentation (#193) * initial benchmarks page + README.md updates * fix(pre_commit): 🎨 auto format pre-commit hooks * final benchmarks page changes * update benchmarking page --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * update mkdocs.yml to fix: (#194) DeprecationWarning: Passing extra options directly under `options` is deprecated. Instead, pass them under `options.extra`, and update your templates. Current extra (unrecognized) options: sort_members * update docs building workflow to build docs page on every develop change (#195) * initial commit (#197) * initial commit * fix(pre_commit): 🎨 auto format pre-commit hooks * updated docs page examples * fix(pre_commit): 🎨 auto format pre-commit hooks * updated README.md code snippets * fix(pre_commit): 🎨 auto format pre-commit hooks * updated README.md tracking algorithms table * Add badges to README for project information Added badges for version, downloads, license, Python version, and Discord. * final updates --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Updated build and release GH actions (#198) * updated build and release GH actions * fix(pre_commit): 🎨 auto format pre-commit hooks --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * include links to example notebooks (#199) * final tests before release with `2.1.0rc1` tag * bump version from `2.1.0rc1` to `2.1.0` --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Alex Bodner <yodabodner@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alexander Bodner <61150961+AlexBodner@users.noreply.github.com> Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com> Co-authored-by: Tomasz Stańczyk <47631823+tstanczyk95@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This pull request introduces several documentation and configuration improvements for the
trackerslibrary, with a focus on enhancing user onboarding and the presentation of tutorials. The main changes include the addition of a tutorials section to the documentation homepage, updates to the documentation theming and markdown capabilities, and a version bump to the stable2.1.0release.Type of Change
Documentation update
Testing