Switch lib-lint-and-test workflow to uv (#4932)

Co-authored-by: Leonardo Lai <[email protected]>

Author: ivanzati

.github/workflows/lib-lint-and-test.yaml

@@ -24,7 +24,7 @@ jobs:
   # Determines if workflow should execute based on event type and changed paths
   # If push or workflow_dispatch -> always run
   # If PR or merge_group -> run only if files in specified paths changed
-  check_paths:
+  check-paths:
     name: Check if workflow should run
     runs-on: ubuntu-latest
     outputs:
@@ -55,95 +55,110 @@ jobs:
             echo "run=false" >> "$GITHUB_OUTPUT"
           fi
 
-  Code-Quality-Checks:
+  code-quality-checks:
     runs-on: ubuntu-24.04
-    needs: check_paths
-    if: needs.check_paths.outputs.run_workflow == 'true'
+    needs: check-paths
+    if: needs.check-paths.outputs.run_workflow == 'true'
     permissions:
       contents: read
     steps:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
+
       - name: Set up Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
-          python-version: "3.12"
-      - name: Install tox
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@3259c6206f993105e3a61b142c2d97bf4b9ef83d # v7.1.0
+        with:
+          version: "0.9.7"
+          enable-cache: false
+
+      - name: Installing dependencies
         working-directory: library
         run: |
-          pip install '.[dev]'
-      - name: Code quality checks
+          uv lock --check
+          uv sync --frozen
+
+      - name: Check formatting with ruff
         working-directory: library
-        run: tox r -vv -e pre-commit
-  Unit-Test:
+        run: |
+          uv run ruff check --output-format=github .
+          uv run ruff format --check .
+
+      # TODO: remove 'continue-on-error' after addressing all mypy issues
+      # https://github.com/open-edge-platform/training_extensions/issues/5006
+      - name: Check source code with mypy
+        continue-on-error: true
+        working-directory: library
+        run: |
+          uv run mypy src/otx
+
+  unit-tests:
     runs-on: [self-hosted, linux, x64, dev, dmount]
     permissions:
       contents: read
+      # The id-token permission is required by Codecov to use OIDC
+      id-token: write
     needs:
-      - Code-Quality-Checks
-      - check_paths
-    if: needs.check_paths.outputs.run_workflow == 'true'
+      - code-quality-checks
+      - check-paths
+    if: needs.check-paths.outputs.run_workflow == 'true'
     timeout-minutes: 120
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - python-version: "3.12"
-            tox-env: "py312"
-          - python-version: "3.11"
-            tox-env: "py311"
-    name: Unit-Test-with-Python${{ matrix.python-version }}
+        python-version: ["3.10", "3.13"]
+    name: unit-tests-with-Python${{ matrix.python-version }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - name: Install Python
+
+      - name: Set up Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install tox
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@3259c6206f993105e3a61b142c2d97bf4b9ef83d # v7.1.0
+        with:
+          version: "0.9.7"
+          enable-cache: false
+
+      - name: Installing dependencies
         working-directory: library
         run: |
-          pip install '.[dev]'
-      - name: Run unit test
+          uv lock --check
+          uv sync --frozen
+
+      - name: Unit testing
         working-directory: library
-        run: tox r -vv -e unit-test-${{ matrix.tox-env }}
+        run: uv run pytest tests/unit --cov --cov-report=xml
+
       - name: Upload coverage reports to Codecov
-        working-directory: library
-        run: |
-          # If the workflow is triggered from PR then it gets the commit id from the PR.
-          # else it uses the commit id of the latest commit. This is because the commit
-          # of the checked-out branch/commit does not exist in the tree as it is grafted.
-          # Also note: GitHub does not pass secrets to pipelines triggered from a fork.
-          # This means that upload will fail for PRs from forks.
-          if [ -n "${{ github.event.pull_request.head.sha }}" ]
-          then
-            COMMIT_ID=${{ github.event.pull_request.head.sha }}
-          else
-            COMMIT_ID=${{ github.sha }}
-          fi
-          # current version of codecov-action does not support uploading reports through the proxy
-          # so we use the latest version of codecov uploader binary
-          curl -Os https://uploader.codecov.io/latest/linux/codecov
-          chmod +x codecov
-          ./codecov -t ${{ secrets.CODECOV_TOKEN }} --sha $COMMIT_ID -U $HTTP_PROXY -f .tox/coverage_unit-test-${{ matrix.tox-env }}.xml -F ${{ matrix.tox-env }}
-  Integration-Test:
-    if: |
-      github.event.pull_request.draft == false &&
-      !(startsWith(github.event.pull_request.title, '[WIP]')) &&
-      needs.check_paths.outputs.run_workflow == 'true'
+        uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
+        with:
+          directory: library
+          flags: coverage_unit-tests_Python-${{ matrix.python-version }}
+          use_oidc: true
+
+  integration-tests:
     runs-on: [self-hosted, linux, x64, dev, dmount]
     permissions:
       contents: read
     needs:
-      - Unit-Test
-      - check_paths
+      - unit-tests
+      - check-paths
     strategy:
       fail-fast: false
       matrix:
+        python-version: ["3.10", "3.13"]
         include:
           - task: "multi_class_cls"
           - task: "multi_label_cls"
@@ -152,31 +167,50 @@ jobs:
           - task: "detection"
           - task: "instance_segmentation"
           - task: "semantic_segmentation"
-    name: Integration-Test-${{ matrix.task }}-py312
+    name: integration-tests-${{ matrix.task }}-py${{ matrix.python-version }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - name: Install Python
+
+      - name: Set up Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
-          python-version: "3.12"
-      - name: Install tox
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@3259c6206f993105e3a61b142c2d97bf4b9ef83d # v7.1.0
+        with:
+          version: "0.9.7"
+          enable-cache: false
+
+      - name: Installing dependencies
         working-directory: library
         run: |
-          pip install '.[dev]'
-      - name: Run Integration Test
+          uv lock --check
+          uv sync --frozen --extra cuda
+
+      - name: Integration testing
         working-directory: library
-        run: tox r -vv -e integration-test-${{ matrix.task }} -- --task ${{ matrix.task }} --run-category-only
+        env:
+          CUBLAS_WORKSPACE_CONFIG: ":4096:8"
+        run: |
+          uv run --frozen --extra cuda pytest tests/integration \
+            -ra \
+            --showlocals \
+            --csv=${{ matrix.task }}_Python-${{ matrix.python-version }}.csv \
+            --task ${{ matrix.task }} \
+            --open-subprocess \
+            --run-category-only
 
-  required_check:
+  required-check:
     name: Required Check lib-lint-and-test
     needs:
-      - check_paths
-      - Code-Quality-Checks
-      - Unit-Test
-      - Integration-Test
+      - check-paths
+      - code-quality-checks
+      - unit-tests
+      - integration-tests
     runs-on: ubuntu-latest
     env:
       CHECKS: ${{ join(needs.*.result, ' ') }}

library/docs/source/guide/get_started/installation.rst

@@ -141,34 +141,32 @@ Example output:
 Run tests
 *********
 
-To run tests locally, install development dependencies:
+To run tests locally, just call `pytest`. `uv` will automatically sync all necessary dependencies.
 
 .. code-block:: shell
 
-    uv pip install -e '.[dev]'
-    pytest tests/
+    uv run pytest tests
 
-To run integration tests using `tox`:
+To run integration tests:
 
 .. code-block:: shell
 
-    uv tool install tox --with tox-uv
-    tox -e integration-test-all
+    uv run pytest tests/integration
 
 .. note::
 
-    The first time `tox` is run, it will create virtual environments and install all required dependencies.
-    This may take several minutes before the actual tests begin.
+    Integration tests may be slow because they involve downloading datasets and simulating training rounds.
+    It is recommended to run them on a platform with GPU/XPU support.
 
 ***************
 Troubleshooting
 ***************
 
-1. If you encounter issues with `uv pip`, update uv:
+1. If you encounter issues with `uv`, update it:
 
 .. code-block:: shell
 
-    pip install --upgrade uv
+    uv self update
 
 2. If you're having issues installing `torch` or `mmcv`, check CUDA compatibility with your PyTorch version.
 Update your CUDA toolkit and drivers if needed. See `CUDA 11.8 Installer <https://developer.nvidia.com/cuda-11-8-0-download-archive?target_os=Linux&target_arch=x86_64&Distribution=Ubuntu&target_version=20.04&target_type=runfile_local>`_.
@@ -178,7 +176,6 @@ Update your CUDA toolkit and drivers if needed. See `CUDA 11.8 Installer <https:
 .. code-block:: shell
 
     export HTTP_PROXY=http://<user>:<password>@<proxy>:<port>
-    uv pip install <package>
 
 4. For CLI-related issues, check the help message:
 

library/docs/source/guide/tutorials/base/explain.rst

@@ -12,14 +12,11 @@ To be specific, this tutorial uses as an example of the ATSS model trained throu
 
 For visualization we use images from WGISD dataset from the :doc:`object detection tutorial <how_to_train/detection>` together with trained model.
 
-1. Activate the virtual environment 
-created in the previous step.
+1. Activate the virtual environment created in the previous step.
 
 .. code-block:: shell
 
-  .otx/bin/activate
-  # or by this line, if you created an environment, using tox
-  . venv/otx/bin/activate
+  source .venv/bin/activate
 
 2. ``otx predict`` with the ``--explain True`` parameter returns saliency maps, 
 which are heatmaps with red-colored areas indicating focus. Here's an example how to generate saliency maps from trained checkpoint:

library/docs/source/guide/tutorials/base/export.rst

@@ -12,14 +12,11 @@ Export
 
     "export" method should be implemented within a framework engine like OTXEngine to be able to export the model. Optimization and validation steps are required to use OVEngine.
 
-1. Activate the virtual environment
-created in the previous step.
+1. Activate the virtual environment created in the previous step.
 
 .. code-block:: shell
 
-    source .otx/bin/activate
-    # or by this line, if you created an environment, using tox
-    . venv/otx/bin/activate
+    source .venv/bin/activate
 
 2. ``otx export`` returns an ``.onnx``, ``openvino.xml(.bin)`` and ``.zip``
 exportable code with demo depending on the export type passed to CLI or API.

library/docs/source/guide/tutorials/base/how_to_train/detection.rst

@@ -26,14 +26,11 @@ Setup virtual environment
 1. You can follow the installation process from a :doc:`quick start guide <../../../get_started/installation>`
 to create a universal virtual environment for OpenVINO™ Training Extensions.
 
-2. Activate your virtual
-environment:
+2. Activate your virtual environment:
 
 .. code-block:: shell
 
-    .otx/bin/activate
-    # or by this line, if you created an environment, using tox
-    . venv/otx/bin/activate
+    source .venv/bin/activate
 
 
 .. _wgisd_dataset_descpiption:

library/docs/source/guide/tutorials/base/how_to_train/instance_segmentation.rst

@@ -24,14 +24,11 @@ Setup virtual environment
 1. You can follow the installation process from a :doc:`quick start guide <../../../get_started/installation>`
 to create a universal virtual environment for OpenVINO™ Training Extensions.
 
-2. Activate your virtual
-environment:
+2. Activate your virtual environment:
 
 .. code-block:: shell
 
-  .otx/bin/activate
-  # or by this line, if you created an environment, using tox
-  . venv/otx/bin/activate
+  source .venv/bin/activate
 
 
 ***************************

library/docs/source/guide/tutorials/base/how_to_train/semantic_segmentation.rst

@@ -23,14 +23,11 @@ Setup virtual environment
 1. You can follow the installation process from a :doc:`quick start guide <../../../get_started/installation>`
 to create a universal virtual environment for OpenVINO™ Training Extensions.
 
-2. Activate your virtual
-environment:
+2. Activate your virtual environment:
 
 .. code-block:: shell
 
-  .otx/bin/activate
-  # or by this line, if you created an environment, using tox
-  . venv/otx/bin/activate
+  source .venv/bin/activate
 
 ***************************
 Dataset preparation