PECOS/.github/workflows/cuda-build-check.yml at dev · PECOS-packages/PECOS · 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
# CUDA Build Check - Verifies CUDA-related crates compile correctly
# Note: Full runtime testing requires cuQuantum SDK which is not available in CI
# For actual GPU testing, use a self-hosted runner with CUDA and cuQuantum installed

name: CUDA Build Check

env:
  RUSTFLAGS: -C debuginfo=0
  RUST_BACKTRACE: 1

on:
  push:
    branches: [ "main", "master", "development", "dev" ]
    paths:
      - 'crates/pecos-cuquantum/**'
      - 'crates/pecos-cuquantum-sys/**'
      - 'python/pecos-rslib-cuda/**'
      - '.github/workflows/cuda-build-check.yml'
  pull_request:
    branches: [ "main", "master", "development", "dev" ]
    paths:
      - 'crates/pecos-cuquantum/**'
      - 'crates/pecos-cuquantum-sys/**'
      - 'python/pecos-rslib-cuda/**'
      - '.github/workflows/cuda-build-check.yml'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  cuda-build-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Free disk space
        run: |
          sudo rm -rf /usr/share/dotnet /usr/local/lib/android /opt/ghc
          sudo apt-get clean
          df -h

      - name: Install Rust
        run: |
          curl https://sh.rustup.rs -sSf | sh -s -- -y
          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
          export PATH="$HOME/.cargo/bin:$PATH"

      - name: Set up Rust
        run: rustup override set stable && rustup update

      - name: Cache Rust
        uses: Swatinem/rust-cache@v2
        with:
          save-if: ${{ github.ref_name == 'main' || github.ref_name == 'master' || github.ref_name == 'development' || github.ref_name == 'dev' }}

      - name: Install CUDA Toolkit
        uses: Jimver/cuda-toolkit@v0.2.30
        id: cuda-toolkit
        with:
          cuda: '12.6.3'
          method: 'network'
          sub-packages: '["nvcc", "cudart-dev"]'
          non-cuda-sub-packages: '["libcublas", "libcublas-dev"]'

      - name: Check pecos-cuquantum-sys compiles (stub mode)
        run: |
          echo "Building pecos-cuquantum-sys (will use stubs since cuQuantum SDK is not installed)..."
          cargo check -p pecos-cuquantum-sys

      - name: Check pecos-cuquantum compiles (stub mode)
        run: |
          echo "Building pecos-cuquantum (will use stubs since cuQuantum SDK is not installed)..."
          cargo check -p pecos-cuquantum

      - name: Check pecos-rslib-cuda compiles (stub mode)
        run: |
          echo "Building pecos-rslib-cuda Python bindings..."
          cargo check -p pecos-rslib-cuda

      - name: Run clippy on CUDA crates
        run: |
          echo "Running clippy on CUDA crates..."
          cargo clippy -p pecos-cuquantum-sys -p pecos-cuquantum -p pecos-rslib-cuda -- -D warnings

      - name: Verify stub mode detection
        run: |
          echo "Verifying that build correctly detects stub mode..."
          # The crates should compile but is_cuquantum_available() should return false
          cargo build -p pecos-cuquantum --release
          # Note: We can't actually run the binary to test is_cuquantum_available()
          # because it requires the cuQuantum runtime, but the build succeeding
          # in stub mode means the detection is working

  # Documentation for setting up GPU testing
  cuda-testing-info:
    runs-on: ubuntu-latest
    steps:
      - name: CUDA Testing Requirements
        run: |
          echo "=============================================="
          echo "CUDA GPU Testing Requirements"
          echo "=============================================="
          echo ""
          echo "Full runtime tests for pecos-rslib-cuda require:"
          echo "  1. NVIDIA GPU with CUDA support"
          echo "  2. CUDA Toolkit 12.x installed"
          echo "  3. cuQuantum SDK installed"
          echo ""
          echo "To run GPU tests locally:"
          echo "  1. Install CUDA Toolkit: https://developer.nvidia.com/cuda-downloads"
          echo "  2. Install cuQuantum SDK: https://developer.nvidia.com/cuquantum-sdk"
          echo "  3. Run: cargo test -p pecos-cuquantum"
          echo "  4. Build Python package: maturin develop -m python/pecos-rslib-cuda/Cargo.toml"
          echo ""
          echo "For self-hosted CI runners with GPU support:"
          echo "  - Use runners labeled with 'cuda' or 'gpu'"
          echo "  - Ensure cuQuantum SDK is pre-installed"
          echo "  - Run: cargo test -p pecos-cuquantum"
          echo "=============================================="