roboflow
diff --git a/‎.github/workflows/build-package.yml‎
Lines changed: 2 additions & 2 deletions b/‎.github/workflows/build-package.yml‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎.github/workflows/ci-build-docs.yml‎
Lines changed: 2 additions & 2 deletions b/‎.github/workflows/ci-build-docs.yml‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎.github/workflows/ci-integration-tests.yml‎
Lines changed: 30 additions & 0 deletions b/‎.github/workflows/ci-integration-tests.yml‎
Lines changed: 30 additions & 0 deletions
diff --git a/‎.github/workflows/ci-tests.yml‎
Lines changed: 3 additions & 3 deletions b/‎.github/workflows/ci-tests.yml‎
Lines changed: 3 additions & 3 deletions
diff --git a/‎.github/workflows/publish-docs.yml‎
Lines changed: 23 additions & 8 deletions b/‎.github/workflows/publish-docs.yml‎
Lines changed: 23 additions & 8 deletions
diff --git a/‎.github/workflows/publish-pre-release.yml‎
Lines changed: 6 additions & 3 deletions b/‎.github/workflows/publish-pre-release.yml‎
Lines changed: 6 additions & 3 deletions
diff --git a/‎.github/workflows/publish-release.yml‎
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/publish-release.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎.pre-commit-config.yaml‎
Lines changed: 18 additions & 1 deletion b/‎.pre-commit-config.yaml‎
Lines changed: 18 additions & 1 deletion
diff --git a/‎CODE_OF_CONDUCT.md‎
Lines changed: 5 additions & 5 deletions b/‎CODE_OF_CONDUCT.md‎
Lines changed: 5 additions & 5 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 49 additions & 13 deletions b/‎CONTRIBUTING.md‎
Lines changed: 49 additions & 13 deletions
@@ -19,14 +19,14 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: 🐍 Install uv and set Python version ${{ inputs.python-version }}
-        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v7.2.1
         with:
           python-version: ${{ inputs.python-version }}
           activate-environment: true
 
       - name: 🏗️ Build source and wheel distributions
         run: |
-          uv pip install -r pyproject.toml --group build
+          uv sync --frozen --group build
           uv build
           uv run twine check --strict dist/*
 
 
@@ -21,13 +21,13 @@ jobs:
           fetch-depth: 0
 
       - name: 🐍 Install uv and set Python
-        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v7.2.1
         with:
           python-version: "3.10"
           activate-environment: true
 
       - name: 🏗️ Install dependencies
-        run: uv pip install -r pyproject.toml --group docs
+        run: uv sync --frozen --group docs
 
       - name: 🧪 Test Docs Build
         run: uv run mkdocs build --verbose
@@ -0,0 +1,30 @@
+name: Integration Tests
+
+on:
+  pull_request:
+    paths:
+      - 'trackers/eval/**'
+      - 'test/eval/**'
+      - 'test/conftest.py'
+
+jobs:
+  integration-tests:
+    name: TrackEval Parity Validation
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: 🐍 Install uv and set Python version
+        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
+        with:
+          python-version: "3.12"
+          activate-environment: true
+
+      - name: 🚀 Install Packages
+        run: uv sync --frozen --group dev
+
+      - name: 🧪 Run Integration Tests
+        run: uv run pytest -m integration -v --tb=short
@@ -20,15 +20,15 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: 🐍 Install uv and set Python version ${{ matrix.python-version }}
-        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v7.2.1
         with:
           python-version: ${{ matrix.python-version }}
           activate-environment: true
           # TODO(https://github.com/astral-sh/setup-uv/issues/226): Remove this.
           prune-cache: ${{ matrix.os != 'windows-latest' }}
 
       - name: 🚀 Install Packages
-        run: uv pip install -r pyproject.toml --group dev
+        run: uv sync --frozen --group dev
 
       - name: 🧪 Run the Import test
         run: uv run python -c "import trackers"
@@ -37,7 +37,7 @@ jobs:
         shell: bash
         run: |
           if [ -d test ] && [ "$(find test -type f \( -name 'test_*.py' -o -name '*_test.py' \) | wc -l)" -gt 0 ]; then
-            uv run pytest
+            uv run pytest -m "not integration"
           else
             echo "No tests found. Skipping pytest."
           fi
@@ -2,16 +2,20 @@ name: Docs/Build and Publish
 
 on:
   push:
-    branches:
-      - develop
+    branches: [main, develop]
   workflow_dispatch:
+    inputs:
+      ref:
+        description: 'Branch or tag to deploy'
+        required: false
+        default: 'main'
   release:
     types: [published]
 
 # Ensure only one concurrent deployment
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.ref}}
-  cancel-in-progress: true
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
 
 # Restrict permissions by default
 permissions:
@@ -29,27 +33,37 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
+          ref: ${{ github.event.inputs.ref || github.ref }}
 
       - name: 🐍 Install uv and set Python
-        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v7.2.1
         with:
           python-version: "3.10"
           activate-environment: true
 
       - name: 🏗️ Install dependencies
-        run: uv pip install -r pyproject.toml --group docs
+        run: uv sync --frozen --group docs
 
       - name: ⚙️ Configure git for github-actions
         run: |
           git config --global user.name "${{ github.actor }}"
           git config --global user.email "${{ github.actor }}@users.noreply.github.com"
 
       - name: 🚀 Deploy Development Docs
-        if: (github.event_name == 'push' && github.ref == 'refs/heads/develop') || github.event_name == 'workflow_dispatch'
+        if: (github.event_name == 'push' && github.ref == 'refs/heads/develop')
+        env:
+          MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
+        run: uv run mike deploy --push develop
+
+      - name: 🚀 Deploy Custom Ref Docs
+        if: github.event_name == 'workflow_dispatch'
         env:
           MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          uv run mike deploy --push develop
+          REF_NAME="${{ github.event.inputs.ref }}"
+          # If it's a full ref like refs/heads/branch or refs/tags/tag, extract the name
+          CLEAN_REF=$(echo "$REF_NAME" | sed 's|^refs/[^/]*/||')
+          uv run mike deploy --push $CLEAN_REF
 
       - name: 🚀 Deploy Release Docs
         if: github.event_name == 'release' && github.event.action == 'published'
@@ -58,3 +72,4 @@ jobs:
         run: |
           latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
           uv run mike deploy --push --update-aliases $latest_tag latest
+          uv run mike set-default --push latest
@@ -3,9 +3,12 @@ name: Publish Trackers Pre-Releases to PyPI
 on:
   push:
     tags:
-      - "[0-9]+.[0-9]+[0-9]+.[0-9]+a[0-9]"
-      - "[0-9]+.[0-9]+[0-9]+.[0-9]+b[0-9]"
-      - "[0-9]+.[0-9]+[0-9]+.[0-9]+rc[0-9]"
+      - "[0-9]+.[0-9]+.[0-9]+a[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+b[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+.a[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+.b[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+.rc[0-9]+"
   workflow_dispatch:
   pull_request:
     branches: [main, develop]
 
@@ -3,7 +3,7 @@ name: Publish Trackers Releases to PyPI
 on:
   push:
     tags:
-      - "[0-9]+.[0-9]+[0-9]+.[0-9]"
+      - "[0-9]+.[0-9]+.[0-9]+"
   workflow_dispatch:
   pull_request:
     branches: [main, develop]
 
@@ -21,13 +21,30 @@ repos:
       - id: mixed-line-ending
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.14
+    rev: v0.15.1
     hooks:
       - id: ruff-check
         args: [--fix]
       - id: ruff-format
         types_or: [python, pyi, jupyter]
 
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        exclude: ^docs/reference/
+        additional_dependencies:
+          - "mdformat-mkdocs[recommended]>=2.1.0"
+          - "mdformat-ruff"
+        args: ["--number"]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: 'v1.19.1'
     hooks:
 
@@ -21,20 +21,20 @@ community include:
 - Being respectful of differing opinions, viewpoints, and experiences
 - Giving and gracefully accepting constructive feedback
 - Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
+    and learning from the experience
 - Focusing on what is best not just for us as individuals, but for the overall
-  community
+    community
 
 Examples of unacceptable behavior include:
 
 - The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
+    any kind
 - Trolling, insulting or derogatory comments, and personal or political attacks
 - Public or private harassment
 - Publishing others' private information, such as a physical or email address,
-  without their explicit permission
+    without their explicit permission
 - Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+    professional setting
 
 ## Enforcement Responsibilities
 
 
@@ -5,37 +5,73 @@ Thank you for your interest in contributing to the Trackers library! Your help
 ## Table of Contents
 
 1. [How to Contribute](#how-to-contribute)
-2. [CLA Signing](#cla-signing)
-3. [Clean Room Requirements](#clean-room-requirements)
-4. [Google-Style Docstrings and Type Hints](#google-style-docstrings-and-type-hints)
-5. [Reporting Bugs](#reporting-bugs)
-6. [License](#license)
+2. [Running Tests](#running-tests)
+3. [CLA Signing](#cla-signing)
+4. [Clean Room Requirements](#clean-room-requirements)
+5. [Google-Style Docstrings and Type Hints](#google-style-docstrings-and-type-hints)
+6. [Reporting Bugs](#reporting-bugs)
+7. [License](#license)
 
 ## How to Contribute
 
 Contributions come in many forms: improving features, fixing bugs, suggesting ideas, improving documentation, or adding new tracking methods. Here’s a high-level overview to get you started:
 
 1. [Fork the Repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo): Click the “Fork” button on our GitHub page to create your own copy.
+
 2. [Clone Locally](https://docs.github.com/en/enterprise-server@3.11/repositories/creating-and-managing-repositories/cloning-a-repository): Download your fork to your local development environment.
+
 3. [Create a Branch](https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop): Use a descriptive name to create a new branch:
 
-   ```bash
-   git checkout -b feature/your-descriptive-name
-   ```
+    ```bash
+    git checkout -b feature/your-descriptive-name
+    ```
 
 4. Develop Your Changes: Make your updates, ensuring your commit messages clearly describe your modifications.
+
 5. [Commit and Push](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop): Run:
 
-   ```bash
-   git add .
-   git commit -m "A brief description of your changes"
-   git push -u origin your-descriptive-name
-   ```
+    ```bash
+    git add .
+    git commit -m "A brief description of your changes"
+    git push -u origin your-descriptive-name
+    ```
 
 6. [Open a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request): Submit your pull request against the main development branch. Please detail your changes and link any related issues.
 
 Before merging, check that all tests pass and that your changes adhere to our development and documentation standards.
 
+## Running Tests
+
+Install development dependencies:
+
+```bash
+uv sync --group dev
+```
+
+1. **Unit Tests**: Run the standard test suite:
+
+    ```bash
+    uv run pytest
+    ```
+
+2. **Doctests**: Run only doctests from docstrings:
+
+    ```bash
+    uv run pytest --doctest-modules trackers/ --ignore=test/
+    ```
+
+3. **Integration Tests**: Integration tests validate that our evaluation metrics match TrackEval's results on real MOT datasets. Run integration tests (requires downloading ~50MB of test data):
+
+    ```bash
+    uv run pytest -m integration
+    ```
+
+4. **All Tests**: Run all tests including integration:
+
+    ```bash
+    uv run pytest -m ""
+    ```
+
 ## CLA Signing
 
 In order to maintain the integrity of our project, every pull request must include a signed Contributor License Agreement (CLA). This confirms that your contributions are properly licensed under our Apache 2.0 License. After opening your pull request, simply add a comment stating: