model_api/.github/workflows/pre_commit.yml at master · open-edge-platform/model_api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
name: Pre-Commit Checks

on:
  pull_request:
  merge_group:
    branches:
      - master
  workflow_dispatch: # run on request (no need for PR)

permissions: {} # No permissions by default on workflow level

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  code_quality_checks:
    runs-on: ubuntu-latest
    steps:
      - &checkout
        name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version-file: ".python-version"

      - name: Install uv
        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
        with:
          enable-cache: false
          version: "0.11.13"

      - name: Install dependencies
        run: |
          uv --directory model_api sync --locked --all-extras --group docs
          uv --directory model_converter sync --locked

      - name: Run pre-commit checks
        run: uvx pre-commit run --all-files

  accuracy-tests:
    strategy:
      fail-fast: false
      matrix:
        os:
          - "ubuntu-latest"
          - "windows-latest"
        python-version:
          - "3.11"
          - "3.12"
          - "3.13"
          - "3.14"
        exclude:
          - os: "windows-latest"
            python-version: "3.14" # started to fail with "Windows fatal exception: access violation"
    runs-on: ${{ matrix.os }}
    steps:
      - *checkout

      - &matrix-setup-uv
        name: Install uv
        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
        with:
          enable-cache: false
          python-version: ${{ matrix.python-version }}
          version: "0.11.13"

      - &install-dependencies
        name: Install dependencies
        run: uv --directory model_api sync --locked --group tests --extra-index-url https://download.pytorch.org/whl/cpu

      - name: Prepare test data
        run: uv --directory model_api run python tests/accuracy/download_models.py -d data -j tests/accuracy/public_scope.json -l

      - name: Run Python Test
        run: uv --directory model_api run pytest --data=./data tests/accuracy/test_accuracy.py

  unit-functional-tests:
    strategy:
      fail-fast: false
      matrix:
        os:
          - "ubuntu-24.04"
          - "windows-2022"
        python-version:
          - "3.11"
          - "3.12"
          - "3.13"
          - "3.14"
    name: unit & functional tests (${{ matrix.os }}, Python ${{ matrix.python-version }})
    runs-on: ${{ matrix.os }}
    steps:
      - *checkout

      - *matrix-setup-uv

      - *install-dependencies

      - name: Run python unit tests
        run: uv --directory model_api run pytest tests/unit --cov

      - &prepare-test-data
        name: Prepare test data
        run: |
          uv --directory model_api run python tests/accuracy/download_models.py -d data -j tests/precommit/public_scope.json -l

      - name: Run test
        run: |
          uv --directory model_api run pytest --data=./data tests/functional

  serving_api-tests:
    strategy:
      fail-fast: false
      matrix:
        os:
          - "ubuntu-latest"
        python-version:
          - "3.11"
          - "3.12"
          - "3.13"
          - "3.14"
    runs-on: ${{ matrix.os }}
    steps:
      - name: Set up docker for macOS
        if: startsWith(matrix.os, 'macos-1')
        run: |
          brew install colima docker
          colima start

      - *checkout

      - *matrix-setup-uv

      - name: Install dependencies
        run: uv --directory model_api sync --locked --group tests --extra ovms --extra-index-url https://download.pytorch.org/whl/cpu

      - *prepare-test-data

      - name: serving_api
        run: |
          uv --directory model_api run python -c "from model_api.models import Model; Model.create_model('./data/otx_models/ssd-card-detection.xml').save('ovms_models/ssd-card-detection/1/ssd-card-detection.xml')"
          docker run -d --rm -v $GITHUB_WORKSPACE/model_api/ovms_models/:/models -p 8000:8000 openvino/model_server:latest --model_path /models/ssd-card-detection/ --model_name ssd-card-detection --rest_port 8000 --log_level DEBUG --target_device CPU
          uv --directory model_api run python examples/serving_api/run.py data/coco128/images/train2017/000000000009.jpg  # detects 4 objects

  pre-commit-result:
    runs-on: ubuntu-latest
    needs:
      - accuracy-tests
      - code_quality_checks
      - unit-functional-tests
      - serving_api-tests
    if: always()
    steps:
      - name: All tests ok
        if: ${{ !(contains(needs.*.result, 'failure')) }}
        run: exit 0

      - name: Some tests failed
        if: ${{ contains(needs.*.result, 'failure') }}
        run: exit 1