trainingsample 0.2.16__tar.gz → 0.2.17__tar.gz

{trainingsample-0.2.16 → trainingsample-0.2.17}/.github/workflows/ci.yml

@@ -32,12 +32,12 @@ jobs:
         ls -la /usr/lib/llvm-18/lib/libclang.so
         which llvm-config-18
 
-        # Build OpenCV 4.12 from source since Ubuntu 24.04 only has 4.6
-        echo "Building OpenCV 4.12 from source..."
+        # Build OpenCV 4.11 from source since Ubuntu 24.04 only has 4.6
+        echo "Building OpenCV 4.11 from source..."
         cd /tmp
-        wget -q https://github.com/opencv/opencv/archive/4.12.0.tar.gz
-        tar -xzf 4.12.0.tar.gz
-        cd opencv-4.12.0
+        wget -q https://github.com/opencv/opencv/archive/4.11.0.tar.gz
+        tar -xzf 4.11.0.tar.gz
+        cd opencv-4.11.0
         mkdir build
         cd build
         cmake \
@@ -127,12 +127,12 @@ jobs:
         ls -la /usr/lib/llvm-18/lib/libclang.so
         which llvm-config-18
 
-        # Build OpenCV 4.12 from source since Ubuntu 24.04 only has 4.6
-        echo "Building OpenCV 4.12 from source..."
+        # Build OpenCV 4.11 from source since Ubuntu 24.04 only has 4.6
+        echo "Building OpenCV 4.11 from source..."
         cd /tmp
-        wget -q https://github.com/opencv/opencv/archive/4.12.0.tar.gz
-        tar -xzf 4.12.0.tar.gz
-        cd opencv-4.12.0
+        wget -q https://github.com/opencv/opencv/archive/4.11.0.tar.gz
+        tar -xzf 4.11.0.tar.gz
+        cd opencv-4.11.0
         mkdir build
         cd build
         cmake \
@@ -218,12 +218,12 @@ jobs:
         ls -la /usr/lib/llvm-18/lib/libclang.so
         which llvm-config-18
 
-        # Build OpenCV 4.12 from source since Ubuntu 24.04 only has 4.6
-        echo "Building OpenCV 4.12 from source..."
+        # Build OpenCV 4.11 from source since Ubuntu 24.04 only has 4.6
+        echo "Building OpenCV 4.11 from source..."
         cd /tmp
-        wget -q https://github.com/opencv/opencv/archive/4.12.0.tar.gz
-        tar -xzf 4.12.0.tar.gz
-        cd opencv-4.12.0
+        wget -q https://github.com/opencv/opencv/archive/4.11.0.tar.gz
+        tar -xzf 4.11.0.tar.gz
+        cd opencv-4.11.0
         mkdir build
         cd build
         cmake \
@@ -298,12 +298,12 @@ jobs:
         ls -la /usr/lib/llvm-18/lib/libclang.so
         which llvm-config-18
 
-        # Build OpenCV 4.12 from source since Ubuntu 24.04 only has 4.6
-        echo "Building OpenCV 4.12 from source..."
+        # Build OpenCV 4.11 from source since Ubuntu 24.04 only has 4.6
+        echo "Building OpenCV 4.11 from source..."
         cd /tmp
-        wget -q https://github.com/opencv/opencv/archive/4.12.0.tar.gz
-        tar -xzf 4.12.0.tar.gz
-        cd opencv-4.12.0
+        wget -q https://github.com/opencv/opencv/archive/4.11.0.tar.gz
+        tar -xzf 4.11.0.tar.gz
+        cd opencv-4.11.0
         mkdir build
         cd build
         cmake \
@@ -348,19 +348,19 @@ jobs:
     - name: Install maturin (Linux/macOS)
       run: pip install maturin[patchelf]
 
-    - name: Install OpenCV (macOS)
+    - name: Install OpenCV build dependencies (macOS)
       if: runner.os == 'macOS'
       run: |
-        # Install OpenCV and LLVM via Homebrew
-        brew install opencv llvm
+        # Build against a pinned OpenCV version instead of Homebrew's moving target
+        brew install llvm cmake nasm pkg-config
         # Set up LLVM environment for opencv-rust bindings (keg-only installation)
         echo "LIBCLANG_PATH=/opt/homebrew/opt/llvm/lib" >> $GITHUB_ENV
         echo "LLVM_CONFIG_PATH=/opt/homebrew/opt/llvm/bin/llvm-config" >> $GITHUB_ENV
         echo "DYLD_LIBRARY_PATH=/opt/homebrew/opt/llvm/lib:$DYLD_LIBRARY_PATH" >> $GITHUB_ENV
-        # Set up OpenCV environment
-        echo "OPENCV_LINK_LIBS=opencv_calib3d,opencv_core,opencv_dnn,opencv_features2d,opencv_flann,opencv_highgui,opencv_imgcodecs,opencv_imgproc,opencv_ml,opencv_objdetect,opencv_photo,opencv_stitching,opencv_video,opencv_videoio" >> $GITHUB_ENV
-        echo "OPENCV_LINK_PATHS=/opt/homebrew/lib" >> $GITHUB_ENV
-        echo "OPENCV_INCLUDE_PATHS=/opt/homebrew/include/opencv4" >> $GITHUB_ENV
+
+    - name: Build static OpenCV (macOS)
+      if: runner.os == 'macOS'
+      run: ./scripts/build-opencv-static.sh
 
     - name: Build wheels (Linux)
       if: runner.os == 'Linux'
@@ -369,6 +369,11 @@ jobs:
     - name: Build wheels (macOS)
       if: runner.os == 'macOS'
       run: maturin build --release --out dist --no-default-features --features python-bindings,simd,opencv,metal
+      env:
+        OPENCV_INCLUDE_PATHS: ${{ github.workspace }}/third_party/opencv-static/include/opencv4
+        OPENCV_LINK_PATHS: ${{ github.workspace }}/third_party/opencv-static/lib
+        OPENCV_LINK_LIBS: static=opencv_world,static=avformat,static=avcodec,static=avfilter,static=swresample,static=swscale,static=avutil,static=jpeg,static=png,static=tiff,static=webp,static=jasper,framework=Accelerate,dylib=c++,framework=OpenCL,z
+        OPENCV_DISABLE_PROBES: pkg_config,cmake,vcpkg,vcpkg_cmake
 
 
     - name: Upload wheels
@@ -398,12 +403,12 @@ jobs:
         echo "LLVM_CONFIG_PATH=/usr/bin/llvm-config-18" >> $GITHUB_ENV
         echo "LD_LIBRARY_PATH=/usr/lib/llvm-18/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
 
-        # Build OpenCV 4.12 from source
-        echo "Building OpenCV 4.12 from source..."
+        # Build OpenCV 4.11 from source
+        echo "Building OpenCV 4.11 from source..."
         cd /tmp
-        wget -q https://github.com/opencv/opencv/archive/4.12.0.tar.gz
-        tar -xzf 4.12.0.tar.gz
-        cd opencv-4.12.0
+        wget -q https://github.com/opencv/opencv/archive/4.11.0.tar.gz
+        tar -xzf 4.11.0.tar.gz
+        cd opencv-4.11.0
         mkdir build
         cd build
         cmake \

{trainingsample-0.2.16 → trainingsample-0.2.17}/.github/workflows/publish.yml

@@ -49,7 +49,7 @@ jobs:
       uses: actions/cache@v4
       with:
         path: third_party/opencv-static
-        key: opencv-static-4.12.0-codecs-jasper-ffmpeg-no-itt-no-openjpeg-linux-${{ matrix.os }}-${{ runner.arch }}-${{ matrix.manylinux }}
+        key: opencv-static-4.11.0-codecs-jasper-ffmpeg-no-itt-no-openjpeg-linux-${{ matrix.os }}-${{ runner.arch }}-${{ matrix.manylinux }}
 
     - name: Install build dependencies
       run: |
@@ -112,7 +112,7 @@ jobs:
         # OpenCV static linking configuration
         OPENCV_INCLUDE_PATHS: ${{ github.workspace }}/third_party/opencv-static/include/opencv4
         OPENCV_LINK_PATHS: ${{ github.workspace }}/third_party/opencv-static/lib
-        OPENCV_LINK_LIBS: static=opencv_world,static=avformat,static=avcodec,static=avfilter,static=swresample,static=swscale,static=avutil,static=jpeg,static=png,static=tiff,static=webp,static=z,static=jasper,static=stdc++
+        OPENCV_LINK_LIBS: static=opencv_world,static=avformat,static=avcodec,static=avfilter,static=swresample,static=swscale,static=avutil,static=jpeg,static=png,static=tiff,static=webp,static=z,static=jasper,dylib=stdc++
         OPENCV_DISABLE_PROBES: pkg_config,cmake,vcpkg,vcpkg_cmake
 
     - name: Repair wheels
@@ -147,7 +147,7 @@ jobs:
       uses: actions/cache@v4
       with:
         path: third_party/opencv-static
-        key: opencv-static-4.12.0-codecs-jasper-ffmpeg-no-itt-no-openjpeg-linux-aarch64-${{ runner.arch }}-manylinux_2_39
+        key: opencv-static-4.11.0-codecs-jasper-ffmpeg-no-itt-no-openjpeg-linux-aarch64-${{ runner.arch }}-manylinux_2_39
 
     - name: Install build dependencies
       run: |
@@ -194,7 +194,7 @@ jobs:
         # OpenCV static linking configuration
         OPENCV_INCLUDE_PATHS: ${{ github.workspace }}/third_party/opencv-static/include/opencv4
         OPENCV_LINK_PATHS: ${{ github.workspace }}/third_party/opencv-static/lib
-        OPENCV_LINK_LIBS: static=opencv_world,static=avformat,static=avcodec,static=avfilter,static=swresample,static=swscale,static=avutil,static=jpeg,static=png,static=tiff,static=webp,static=z,static=jasper,static=stdc++
+        OPENCV_LINK_LIBS: static=opencv_world,static=avformat,static=avcodec,static=avfilter,static=swresample,static=swscale,static=avutil,static=jpeg,static=png,static=tiff,static=webp,static=z,static=jasper,dylib=stdc++
         OPENCV_DISABLE_PROBES: pkg_config,cmake,vcpkg,vcpkg_cmake
 
     - name: Repair wheels
@@ -229,7 +229,7 @@ jobs:
       uses: actions/cache@v4
       with:
         path: third_party/opencv-static
-        key: opencv-static-4.12.0-codecs-jasper-ffmpeg-no-itt-no-openjpeg-macos-${{ runner.os }}-${{ runner.arch }}
+        key: opencv-static-4.11.0-codecs-jasper-ffmpeg-no-itt-no-openjpeg-macos-${{ runner.os }}-${{ runner.arch }}
 
     - name: Install build dependencies
       run: |

trainingsample-0.2.17/BENCHMARKS.md

@@ -0,0 +1,137 @@
+# Performance Benchmarks
+
+TrainingSample includes benchmarks for common preprocessing operations: crop, resize, luminance, resize-plus-luminance pipelines, and video frame resizing. The benchmarks are meant to catch regressions and provide workload-specific guidance, not to guarantee universal speedups over OpenCV or NumPy.
+
+## Running Benchmarks
+
+Use the repository virtual environment when available:
+
+```bash
+.venv/bin/python -m pytest tests/test_performance_benchmarks.py -q -s
+```
+
+To run every Python test and benchmark marker in the repo:
+
+```bash
+.venv/bin/python -m pytest -q
+```
+
+For a fresh source build before measuring:
+
+```bash
+env -u OPENCV_LINK_LIBS -u OPENCV_LINK_PATHS -u OPENCV_INCLUDE_PATHS \
+    -u LIBCLANG_PATH -u LLVM_CONFIG_PATH \
+    .venv/bin/maturin develop --release
+```
+
+The OpenCV Rust binding needs a discoverable OpenCV and Clang installation. On this development host, stale macOS-style OpenCV and LLVM environment variables had to be unset before the build could probe the system OpenCV installation.
+
+## Current Local Snapshot
+
+Last measured command:
+
+```bash
+.venv/bin/python -m pytest tests/test_performance_benchmarks.py -q -s
+```
+
+Environment:
+
+- Linux x86_64
+- CPython 3.13
+- NumPy 2.3.4
+- system OpenCV 4.11 via the Rust `opencv` crate
+- release build installed with `maturin develop --release`
+
+Point-in-time scenario timings from the benchmark output:
+
+| Scenario | Before optimization | After optimization | Comparison after optimization |
+|----------|---------------------|--------------------|-------------------------------|
+| Crop batch, 16 images | 22.9 ms | 0.4 ms | NumPy slicing was still faster because it returns views |
+| Mixed-shape crop, 8 images | 50.2 ms | 3.3 ms | NumPy slicing loop was near-zero because it returns views |
+| Resize, 4 mixed-size images | 4.1 ms | 0.4 ms | OpenCV loop: 2.6 ms |
+| Luminance, 4 mixed-size images | 10.4 ms | 0.6 ms | OpenCV loop: 0.9 ms |
+| Resize + luminance pipeline, 4 images | 5.9 ms | 0.6 ms | OpenCV loop: 2.1 ms |
+| Mixed-shape luminance, 6 images | 78.3 ms | 3.3 ms | NumPy loop: 19.4 ms |
+
+Pytest-benchmark means from the same focused run:
+
+| Benchmark | Mean |
+|-----------|------|
+| Center crop | 55.2 us |
+| Resize operations | 353.1 us |
+| Luminance calculation | 417.2 us |
+| Crop operations | 583.8 us |
+| Pipeline | 3.44 ms |
+| Video processing | 2.85 ms |
+
+A full `pytest -q` run also passed and produced similar benchmark ordering, with normal run-to-run variance.
+
+## What Changed in the Latest Optimization
+
+- Owned Rust `ndarray` outputs are transferred into NumPy with `from_owned_array_bound`, avoiding an additional copy in Python-facing result conversion.
+- Contiguous luminance inputs use a channel-sum fast path. Instead of computing weighted luminance per pixel, it sums R, G, and B separately and applies the weights once at the end.
+- Non-contiguous arrays still use the general ndarray path for correctness.
+
+## Benchmark Categories
+
+### Image Operations
+
+- `batch_crop_images`
+- `batch_center_crop_images`
+- `batch_random_crop_images`
+- `batch_resize_images`
+- `batch_calculate_luminance`
+
+### Pipeline Operations
+
+- resize followed by luminance
+- crop followed by resize
+- mixed input sizes and output sizes
+
+### Video Operations
+
+- `batch_resize_videos` with frame batches shaped `(T, H, W, 3)`
+
+## Interpreting Results
+
+Use these benchmarks to answer practical questions:
+
+- Is a change adding extra Rust-to-NumPy copies?
+- Are contiguous arrays staying on the fast path?
+- Is resize dominated by OpenCV work or Python binding overhead?
+- Does a mixed-shape batch still behave reasonably?
+- Is a video processing change accidentally introducing per-frame Python overhead?
+
+Some comparisons need context:
+
+- NumPy crop by slicing often returns a view, so it can be much faster than any function that returns owned cropped arrays.
+- Very small images can be dominated by Python call overhead.
+- Large images can be dominated by memory bandwidth rather than arithmetic.
+- OpenCV performance varies by build options, CPU features, and linked libraries.
+
+## Quality Checks
+
+The tests validate basic output behavior alongside timing:
+
+- Crop outputs have expected shape and match NumPy slicing where ownership differences do not matter.
+- Resize outputs have expected shape and are close to OpenCV output for the configured interpolation.
+- Luminance stays within a small tolerance of NumPy/OpenCV-style references.
+- Non-contiguous arrays are accepted by safe luminance paths and rejected by strict zero-copy crop/resize paths.
+
+## Regression Signals
+
+Investigate if a change causes:
+
+- Public batch crop to return to multi-millisecond timings for small batches.
+- Luminance on contiguous RGB arrays to lose the channel-sum fast path.
+- Resize benchmarks to add large overhead beyond OpenCV work.
+- Video resizing to scale with per-frame Python object churn.
+- Memory usage to grow unexpectedly for repeated batch calls.
+
+## Future Benchmark Work
+
+- Store historical benchmark results by commit and host.
+- Add explicit memory allocation tracking for Python-facing APIs.
+- Separate view-returning crop comparisons from owned-output crop comparisons.
+- Add more video pipeline benchmarks.
+- Document hardware and OpenCV build details in benchmark artifacts.