Merge pull request #28 from VectorInstitute/migrate_to_uv_lint_fixes

Migrate to uv, add lint fixes, improvements and some unit tests

Author: XkunW

.github/workflows/code_checks.yml

@@ -9,7 +9,7 @@ on:
       - .pre-commit-config.yaml
       - .github/workflows/code_checks.yml
       - '**.py'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
       - '**.ipynb'
   pull_request:
@@ -20,29 +20,30 @@ on:
       - .pre-commit-config.yaml
       - .github/workflows/code_checks.yml
       - '**.py'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
       - '**.ipynb'
 
 jobs:
   run-code-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
-      - name: Install and configure Poetry
-        uses: snok/install-poetry@v1
+      - uses: actions/checkout@v4.2.2
+      - name: Install uv
+        uses: astral-sh/[email protected]
         with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-      - uses: actions/[email protected]
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
+      - name: "Set up Python"
+        uses: actions/[email protected]
         with:
-          python-version: '3.10'
-          cache: 'poetry'
+          python-version-file: ".python-version"
+      - name: Install the project
+        run: uv sync --dev
       - name: Install dependencies and check code
         run: |
-          poetry env use '3.10'
           source .venv/bin/activate
-          poetry install --with test --all-extras
           pre-commit run --all-files
       - name: pip-audit (gh-action-pip-audit)
         uses: pypa/[email protected]

.github/workflows/unit_tests.yml

@@ -0,0 +1,71 @@
+name: unit tests
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - .github/workflows/docs_build.yml
+      - .github/workflows/docs_deploy.yml
+      - .github/workflows/unit_tests.yml
+      - .github/workflows/integration_tests.yml
+      - '**.py'
+      - '**.ipynb'
+      - uv.lock
+      - pyproject.toml
+      - '**.rst'
+      - '**.md'
+  pull_request:
+    branches:
+      - main
+      - develop
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - .github/workflows/docs_build.yml
+      - .github/workflows/docs_deploy.yml
+      - .github/workflows/unit_tests.yml
+      - .github/workflows/integration_tests.yml
+      - '**.py'
+      - '**.ipynb'
+      - uv.lock
+      - pyproject.toml
+      - '**.rst'
+      - '**.md'
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Install uv
+        uses: astral-sh/[email protected]
+        with:
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/[email protected]
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Install dependencies and check code
+        run: |
+          uv run pytest -m "not integration_test" --cov vec_inf --cov-report=xml tests
+
+      # Uncomment this once this repo is configured on Codecov
+      - name: Upload coverage to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: VectorInstitute/vec-inf
+          fail_ci_if_error: true
+          verbose: true

.gitignore

@@ -81,9 +81,6 @@ target/
 profile_default/
 ipython_config.py
 
-# pyenv
-.python-version
-
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 #   However, in case of collaboration, if having platform-specific dependencies or dependencies

.pre-commit-config.yaml

@@ -39,6 +39,15 @@ repos:
     - id: nbqa-ruff
       args: [--fix, --exit-non-zero-on-fix]
 
+  - repo: local
+    hooks:
+    - id: pytest
+      name: pytest
+      entry: python3 -m pytest -m "not integration_test"
+      language: system
+      pass_filenames: false
+      always_run: true
+
 ci:
   autofix_commit_msg: |
     [pre-commit.ci] Add auto fixes from pre-commit.com hooks
@@ -48,5 +57,5 @@ ci:
   autoupdate_branch: ''
   autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
   autoupdate_schedule: weekly
-  skip: [mypy]
+  skip: [pytest,mypy]
   submodules: false

.python-version

@@ -0,0 +1 @@
+3.10

codecov.yml

@@ -0,0 +1,19 @@
+codecov:
+  require_ci_to_pass: true
+  notify:
+    after_n_builds: 2
+    wait_for_ci: yes
+comment:
+  behavior: default
+  layout: reach,diff,flags,tree,reach
+  show_carryforward_flags: false
+  require_changes: true
+coverage:
+  status:
+    changes: true
+    default_rules:
+      flag_coverage_not_uploaded_behavior: include
+    patch: true
+    project: true
+github_checks:
+  annotations: true

examples/inference/llm/chat_completions.py

@@ -1,6 +1,10 @@
+"""Example of how to use the OpenAI API to generate chat completions."""
+
 from openai import OpenAI
 
-# The url is located in the .vLLM_model-variant_url file in the corresponding model directory.
+
+# The url is located in the .vLLM_model-variant_url file in the corresponding
+# model directory.
 client = OpenAI(base_url="http://gpuXXX:XXXX/v1", api_key="EMPTY")
 
 # Update the model path accordingly

examples/inference/llm/completions.py

@@ -1,6 +1,10 @@
+"""Example of how to use the OpenAI API to generate completions."""
+
 from openai import OpenAI
 
-# The url is located in the .vLLM_model-variant_url file in the corresponding model directory.
+
+# The url is located in the .vLLM_model-variant_url file in the corresponding
+# model directory.
 client = OpenAI(base_url="http://gpuXXX:XXXX/v1", api_key="EMPTY")
 
 # Update the model path accordingly

examples/inference/vlm/vision_completions.py

@@ -1,6 +1,10 @@
+"""Example of using the OpenAI API to generate completions for vision tasks."""
+
 from openai import OpenAI
 
-# The url is located in the .vLLM_model-variant_url file in the corresponding model directory.
+
+# The url is located in the .vLLM_model-variant_url file in the corresponding
+# model directory.
 client = OpenAI(base_url="http://gpuXXX:XXXX/v1", api_key="EMPTY")
 
 # Update the model path accordingly

examples/logits/logits.py

@@ -1,6 +1,10 @@
+"""Example of how to get logits from the model."""
+
 from openai import OpenAI
 
-# The url is located in the .vLLM_model-variant_url file in the corresponding model directory.
+
+# The url is located in the .vLLM_model-variant_url file in the corresponding
+# model directory.
 client = OpenAI(base_url="http://gpuXXX:XXXXX/v1", api_key="EMPTY")
 
 completion = client.completions.create(