Merge pull request #1851 from roboflow/feature/new-inference-docs

Rename `inference-exp` -> `inference-models`

Author: PawelPeczek-Roboflow

.dockerignore

@@ -41,4 +41,4 @@ lora-bases
 lora-tars
 tmptmp
 
-inference_experimental
+inference_models

.github/workflows/docker.inference-exp.yml

@@ -5,7 +5,7 @@ on:
     inputs:
       image_variant:
         type: string
-        description: "Image variant to build (e.g., 'cpu', 'cu124', 'jp61') or 'all' for all images. Run 'ls inference_experimental/dockerfiles/' to see available options."
+        description: "Image variant to build (e.g., 'cpu', 'cu124', 'jp61') or 'all' for all images. Run 'ls inference_models/dockerfiles/' to see available options."
         required: true
         default: "all"
       force_push:
@@ -38,7 +38,7 @@ jobs:
 
       - name: Read version from pyproject.toml
         run: |
-          cd inference_experimental
+          cd inference_models
           VERSION=$(grep -E '^version = ' pyproject.toml | cut -d'"' -f2)
           echo "VERSION=${VERSION}"
           echo "VERSION=${VERSION}" >> $GITHUB_ENV
@@ -145,5 +145,5 @@ jobs:
           project: grl7ffzxd7
           tags: ${{ steps.image-tags.outputs.tags }}
           platforms: ${{ matrix.build_platforms }}
-          file: ./inference_experimental/dockerfiles/${{ matrix.dockerfile }}
-          context: ./inference_experimental
+          file: ./inference_models/dockerfiles/${{ matrix.dockerfile }}
+          context: ./inference_models

.github/workflows/e2e_tests_inference_experimental_cpu.yml

@@ -1,4 +1,4 @@
-name: E2E tests - inference_experimental (CPU)
+name: E2E tests - inference_models (CPU)
 permissions:
   contents: read
 on:
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  e2e-tests-inference-experimental-gpu:
+  e2e-tests-inference-models-gpu:
     runs-on:
       labels: depot-ubuntu-22.04-4
       group: public-depot
@@ -19,7 +19,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-uv-3.12-${{ hashFiles('inference_experimental/pyproject.toml') }}
+          key: ${{ runner.os }}-uv-3.12-${{ hashFiles('inference_models/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-uv-3.12-
       - name: 📦 Cache apt packages
@@ -35,14 +35,14 @@ jobs:
           python-version: 3.12
           check-latest: true
       - name: 📦 Install dependencies
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           python -m pip install --upgrade pip
           python -m pip install uv
           python -m uv venv
           python -m uv pip install -e .[test,onnx-cpu,torch-cpu,mediapipe] --python .venv
       - name: 🧪 Run E2E tests
-        working-directory: inference_experimental
+        working-directory: inference_models
         timeout-minutes: 20
         run: |
           source .venv/bin/activate

.github/workflows/e2e_tests_inference_experimental_gpu.yml

@@ -1,4 +1,4 @@
-name: E2E tests - inference_experimental (GPU)
+name: E2E tests - inference_models (GPU)
 permissions:
   contents: read
 on:
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  e2e-tests-inference-experimental-gpu:
+  e2e-tests-inference-models-gpu:
     runs-on: Roboflow-GPU-VM-Runner
     timeout-minutes: 30
     steps:
@@ -17,7 +17,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-uv-3.12-${{ hashFiles('inference_experimental/pyproject.toml') }}
+          key: ${{ runner.os }}-uv-3.12-${{ hashFiles('inference_models/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-uv-3.12-
       - name: 📦 Cache apt packages
@@ -50,7 +50,7 @@ jobs:
           sudo cp /var/cache/apt/archives/*.deb ~/apt-cache/ 2>/dev/null || true
           sudo chown -R $(whoami):$(whoami) ~/apt-cache
       - name: 📦 Install dependencies
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           export CUDA_HOME=/usr/local/cuda-12.5
           export PATH=/usr/local/cuda-12.5/bin:$PATH
@@ -62,7 +62,7 @@ jobs:
           python -m uv venv
           python -m uv pip install -e .[test,onnx-cu12,trt10,torch-cu124,mediapipe] --python .venv
       - name: 🧪 Run E2E tests
-        working-directory: inference_experimental
+        working-directory: inference_models
         timeout-minutes: 20
         run: |
           source .venv/bin/activate

.github/workflows/integration_e2e_tests_inference_sdk_x86.yml

@@ -35,6 +35,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-${{ matrix.python-version }}-
 
+      - name: 🚧 Install OS dependencies
+        run: sudo add-apt-repository ppa:ubuntuhandbook1/ffmpeg7 && sudo apt-get update && sudo apt-get install -y libavformat-dev libavdevice-dev
+
       - name: 🐍 Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -76,6 +79,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-${{ matrix.python-version }}-
 
+      - name: 🚧 Install OS dependencies
+        run: sudo add-apt-repository ppa:ubuntuhandbook1/ffmpeg7 && sudo apt-get update && sudo apt-get install -y ffmpeg libavformat-dev libavdevice-dev
+
       - name: 🐍 Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:

.github/workflows/integration_tests_inference_experimental_cpu.yml

@@ -1,4 +1,4 @@
-name: INTEGRATION TESTS - inference_experimental (CPU)
+name: INTEGRATION TESTS - inference_models (CPU)
 permissions:
   contents: read
 on:
@@ -29,7 +29,7 @@ on:
           - '3.12'
 
 jobs:
-  integration-tests-inference-experimental-cpu:
+  integration-tests-inference-models-cpu:
     name: ${{ matrix.extras.marker }}:${{ matrix.python-version }}
     runs-on:
       labels: depot-ubuntu-22.04-4
@@ -50,7 +50,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-uv-${{ matrix.python-version }}-${{ hashFiles('inference_experimental/pyproject.toml') }}
+          key: ${{ runner.os }}-uv-${{ matrix.python-version }}-${{ hashFiles('inference_models/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-uv-${{ matrix.python-version }}-
       - name: 🐍 Set up Python ${{ matrix.python-version }}
@@ -61,15 +61,15 @@ jobs:
           check-latest: true
       - name: 📦 Install base dependencies as well as `${{ matrix.extras.install }}` dependencies
         if: ${{ (github.event.inputs.extras == '' || github.event.inputs.extras == matrix.extras.marker) && (github.event.inputs.python_version == '' || github.event.inputs.python_version == matrix.python-version) }}
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           python -m pip install --upgrade pip
           python -m pip install uv
           python -m uv venv
           python -m uv pip install -e .[test,${{ matrix.extras.install }}] --python .venv
       - name: 🧪 Run tests marked `${{ matrix.extras.marker }}`
         if: ${{ (github.event.inputs.extras == '' || github.event.inputs.extras == matrix.extras.marker) && (github.event.inputs.python_version == '' || github.event.inputs.python_version == matrix.python-version) }}
-        working-directory: inference_experimental
+        working-directory: inference_models
         timeout-minutes: 15
         run: |
           source .venv/bin/activate

.github/workflows/integration_tests_inference_experimental_gpu.yml

@@ -1,4 +1,4 @@
-name: INTEGRATION TESTS - inference_experimental (GPU)
+name: INTEGRATION TESTS - inference-models (GPU)
 permissions:
   contents: read
 on:
@@ -26,7 +26,7 @@ on:
           - '3.12'
 
 jobs:
-  integration-tests-inference-experimental-gpu:
+  integration-tests-inference-models-gpu:
     name: ${{ matrix.extras.marker }}:${{ matrix.python-version }}
     runs-on: Roboflow-GPU-VM-Runner
     timeout-minutes: 30
@@ -47,7 +47,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-uv-${{ matrix.python-version }}-${{ hashFiles('inference_experimental/pyproject.toml') }}
+          key: ${{ runner.os }}-uv-${{ matrix.python-version }}-${{ hashFiles('inference_models/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-uv-${{ matrix.python-version }}-
       - name: 📦 Cache apt packages
@@ -84,7 +84,7 @@ jobs:
           sudo chown -R $(whoami):$(whoami) ~/apt-cache
       - name: 📦 Install base dependencies as well as `${{ matrix.extras.install }}` dependencies
         if: ${{ (github.event.inputs.extras == '' || github.event.inputs.extras == matrix.extras.marker) && (github.event.inputs.python_version == '' || github.event.inputs.python_version == matrix.python-version) }}
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           export CUDA_HOME=/usr/local/cuda-12.5
           export PATH=/usr/local/cuda-12.5/bin:$PATH
@@ -97,7 +97,7 @@ jobs:
           python -m uv pip install -e .[test,${{ matrix.extras.install }}] --python .venv
       - name: 🧪 Run tests marked `${{ matrix.extras.marker }}`
         if: ${{ (github.event.inputs.extras == '' || github.event.inputs.extras == matrix.extras.marker) && (github.event.inputs.python_version == '' || github.event.inputs.python_version == matrix.python-version) }}
-        working-directory: inference_experimental
+        working-directory: inference_models
         timeout-minutes: 25
         run: |
           source .venv/bin/activate

.github/workflows/integration_tests_workflows_x86.yml

@@ -37,8 +37,8 @@ jobs:
           key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('requirements/**') }}
           restore-keys: |
             ${{ runner.os }}-pip-${{ matrix.python-version }}-
-      - name: 🚧 Install GDAL OS library
-        run: sudo apt-get update && sudo apt-get install libgdal-dev
+      - name: 🚧 Install OS dependencies
+        run: sudo add-apt-repository ppa:ubuntuhandbook1/ffmpeg7 && sudo apt-get update && sudo apt-get install -y libgdal-dev ffmpeg libavformat-dev libavdevice-dev
       - name: 📦 Install dependencies
         run: |
           python -m pip install --upgrade pip

.github/workflows/publish.pypi.inference_exp.yml

@@ -38,13 +38,13 @@ jobs:
           python-version: ${{ matrix.python-version }}
           check-latest: true
       - name: 📦 Install dependencies
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           python -m pip install --upgrade pip
           python -m pip install uv
       - name: 🏷️ Modify version for pre-release
         if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.pre_release == 'true' }}
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           CURRENT_VERSION=$(grep -m 1 '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
           echo "Current version: $CURRENT_VERSION"
@@ -59,12 +59,12 @@ jobs:
             rm pyproject.toml.bak
           fi
       - name: 🔨 Build package
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           python -m uv build
       - name: 🚀 Publish to PyPI
         if: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true') }}
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          packages-dir: inference_experimental/dist/
+          packages-dir: inference_models/dist/
           skip-existing: true

.github/workflows/unit_tests_inference_experimental.yml

@@ -1,4 +1,4 @@
-name: UNIT TESTS - inference_experimental
+name: UNIT TESTS - inference-models
 permissions:
   contents: read
 on:
@@ -9,7 +9,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  unit-tests-inference-experimental:
+  unit-tests-inference-models:
     runs-on:
       labels: depot-ubuntu-22.04-4
       group: public-depot
@@ -24,7 +24,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-uv-${{ matrix.python-version }}-${{ hashFiles('inference_experimental/pyproject.toml') }}
+          key: ${{ runner.os }}-uv-${{ matrix.python-version }}-${{ hashFiles('inference_models/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-uv-${{ matrix.python-version }}-
       - name: 🐍 Set up Python ${{ matrix.python-version }}
@@ -33,15 +33,15 @@ jobs:
           python-version: ${{ matrix.python-version }}
           check-latest: true
       - name: 📦 Install dependencies
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           python -m pip install --upgrade pip
           python -m pip install uv
           python -m uv venv
           python -m uv pip install -e .[test] --python .venv
       - name: 🧪 Unit Tests
         timeout-minutes: 30
-        working-directory: inference_experimental
+        working-directory: inference_models
         run: |
           source .venv/bin/activate
           python -m pytest -n auto tests/unit_tests