python: packaging and CI

Author: Acly

.github/workflows/ci.yml

@@ -44,6 +44,11 @@ jobs:
           version: 1.4.309.0
           cache: true
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.9.15"        
+
       - name: Configure (Linux)
         if: matrix.os == 'ubuntu-22.04'
         run: >

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.28)
 
-project(vision.cpp VERSION 0.2.0 LANGUAGES CXX)
+project(vision.cpp VERSION 0.3.0 LANGUAGES CXX)
 
 option(BUILD_SHARED_LIBS "Build shared libraries instead of static libraries" ON)
 option(VISP_VULKAN "Enable Vulkan support" OFF)
@@ -145,6 +145,8 @@ if(VISP_CI OR VISP_DEV)
   set_target_properties(vision-cli PROPERTIES INSTALL_RPATH "\$ORIGIN/../${VISP_LIB_INSTALL_DIR}")
 endif()
 
+install(DIRECTORY bindings/python DESTINATION ${CMAKE_INSTALL_PREFIX} PATTERN "__pycache__" EXCLUDE)
+
 include(CMakePackageConfigHelpers)
 
 configure_package_config_file(

README.md

@@ -174,7 +174,7 @@ ctest -C Release
 Some tests require a Python environment. It can be set up with [uv](https://docs.astral.sh/uv/):
 ```sh
 # Setup venv and install dependencies (once only)
-uv sync
+uv sync --dev
 
 # Run python tests
 uv run pytest

bindings/python/visioncpp/_lib.py

@@ -87,16 +87,20 @@ def _load():
     if system == "windows":
         prefix = ""
         suffix = ".dll"
+        libdir = "bin"
     elif system == "darwin":
         prefix = "lib"
         suffix = ".dylib"
+        libdir = "lib"
     else:  # assume Linux / Unix
         prefix = "lib"
         suffix = ".so"
+        libdir = "lib"
     libname = f"{prefix}visioncpp{suffix}"
     paths = [
         cur_dir / libname,
-        cur_dir.parent.parent.parent / "build" / "bin" / libname,
+        cur_dir.parent.parent / libdir / libname,
+        cur_dir.parent.parent.parent / "build" / libdir / libname,
     ]
     error = None
     for path in paths:

pyproject.toml

@@ -3,6 +3,11 @@ dynamic = ["version"]
 name = "vision.cpp"
 requires-python = ">=3.12"
 dependencies = [
+    "pillow",
+]
+
+[dependency-groups]
+dev = [
     "torch",
     "torchvision",
     "timm",
@@ -12,6 +17,7 @@ dependencies = [
     "einops>=0.8.1",
     "spandrel>=0.4.1",
     "gguf>=0.17.1",
+    "boto3~=1.39.0"
 ]
 
 [tool.uv]

tests/CMakeLists.txt

@@ -45,6 +45,14 @@ target_compile_options(vision-workbench PRIVATE ${VISP_COMP_OPTIONS})
 target_link_options(vision-workbench PRIVATE ${VISP_LINK_OPTIONS})
 target_link_libraries(vision-workbench PRIVATE visioncpp ggml ${VISP_FMT_LINK})
 
+#
+# Python tests
+
+if(VISP_CI)
+  set(PYTHON_TESTS_ARGS "--ci")
+endif()
+add_test(NAME python COMMAND uv run pytest -vs tests ${PYTHON_TESTS_ARGS})
+
 #
 # Benchmarks
 

tests/conftest.py

@@ -0,0 +1,17 @@
+import pytest
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--ci",
+        action="store_true",
+        default=False,
+        help="Configure tests for continuous integration environment",
+    )
+
+
+def pytest_collection_modifyitems(config, items):
+    if config.getoption("--ci"):
+        # Filter to keep only tests from test_python_bindings.py
+        filtered_items = [item for item in items if "test_python_bindings.py" in item.nodeid]
+        items[:] = filtered_items

tests/test_primitives.py

@@ -76,7 +76,6 @@ def test_conv_transpose_2d(scenario: str):
     if scenario == "nhwc":
         result = to_nchw(result)
 
-    workbench.print_results(result, expected)
     assert torch.allclose(result, expected, rtol=1e-2)
 
 

tests/test_python_bindings.py

@@ -1,5 +1,6 @@
 import sys
 import numpy as np
+import pytest
 from pathlib import Path
 from PIL import Image
 
@@ -13,6 +14,12 @@
 result_dir.mkdir(parents=True, exist_ok=True)
 ref_dir = root_dir / "tests" / "reference"
 
+@pytest.fixture
+def device(pytestconfig):
+    if pytestconfig.getoption("ci"):
+        return Device.init(Backend.cpu)
+    return Device.init()
+
 
 def compare_images(name: str, result: Image.Image, tolerance: float = 0.015):
     name = f"{name}-gpu.png"
@@ -32,9 +39,8 @@ def compare_images(name: str, result: Image.Image, tolerance: float = 0.015):
         raise AssertionError(f"Images differ: RMSE={rmse} exceeds tolerance={tolerance}")
 
 
-def test_sam():
-    dev = Device.init(Backend.gpu)
-    model = Model.load(model_dir / "MobileSAM-F16.gguf", dev)
+def test_sam(device: Device):
+    model = Model.load(model_dir / "MobileSAM-F16.gguf", device)
     assert model.arch is Arch.sam
 
     img = Image.open(str(image_dir / "cat-and-hat.jpg"))
@@ -43,27 +49,24 @@ def test_sam():
     compare_images("mobile_sam-box", result_box)
     compare_images("mobile_sam-point", result_point)
 
-def test_birefnet():
-    dev = Device.init(Backend.gpu)
-    model = Model.load(model_dir / "BiRefNet-lite-F16.gguf", dev)
+def test_birefnet(device: Device):
+    model = Model.load(model_dir / "BiRefNet-lite-F16.gguf", device)
     assert model.arch is Arch.birefnet
 
     img = Image.open(str(image_dir / "wardrobe.jpg"))
     result = model.compute(img)
     compare_images("birefnet", result)
 
-def test_depth_anything():
-    dev = Device.init(Backend.gpu)
-    model = Model.load(model_dir / "Depth-Anything-V2-Small-F16.gguf", dev)
+def test_depth_anything(device: Device):
+    model = Model.load(model_dir / "Depth-Anything-V2-Small-F16.gguf", device)
     assert model.arch is Arch.depth_anything
 
     img = Image.open(str(image_dir / "wardrobe.jpg"))
     result = model.compute(img)
     compare_images("depth-anything", result)
 
-def test_migan():
-    dev = Device.init(Backend.gpu)
-    model = Model.load(model_dir / "MIGAN-512-places2-F16.gguf", dev)
+def test_migan(device: Device):
+    model = Model.load(model_dir / "MIGAN-512-places2-F16.gguf", device)
     assert model.arch is Arch.migan
 
     img = Image.open(str(image_dir / "bench-image.jpg")).convert("RGBA")
@@ -72,9 +75,8 @@ def test_migan():
     result = Image.alpha_composite(img, result)
     compare_images("migan", result)
 
-def test_esrgan():
-    dev = Device.init(Backend.gpu)
-    model = Model.load(str(model_dir / "RealESRGAN-x4plus_anime-6B-F16.gguf"), dev)
+def test_esrgan(device: Device):
+    model = Model.load(str(model_dir / "RealESRGAN-x4plus_anime-6B-F16.gguf"), device)
     assert model.arch is Arch.esrgan
 
     img = Image.open(str(image_dir / "vase-and-bowl.jpg"))