Fix python formatting #8103
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build Catalyst Wheel on Linux (x86_64) | |
| on: | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - labeled | |
| - ready_for_review | |
| push: | |
| branches: [ main ] | |
| schedule: | |
| # Thursdays we test the standalone plugin | |
| - cron: '35 4 * * 4' | |
| workflow_dispatch: | |
| workflow_call: | |
| concurrency: | |
| group: Build Catalyst Wheel on Linux (x86_64)-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| determine_runner: | |
| if: github.event.pull_request.draft == false | |
| name: Determine runner type to use | |
| uses: ./.github/workflows/determine-workflow-runner.yml | |
| with: | |
| default_runner: ubuntu-22.04 | |
| check_if_wheel_build_required: | |
| if: github.event.pull_request.draft == false | |
| uses: ./.github/workflows/check-for-wheel-build.yml | |
| constants: | |
| needs: [check_if_wheel_build_required, determine_runner] | |
| if: needs.check_if_wheel_build_required.outputs.build-wheels == 'true' | |
| name: "Set build matrix" | |
| uses: ./.github/workflows/constants.yaml | |
| with: | |
| runs_on: ${{ needs.determine_runner.outputs.runner_group }} | |
| build-dependencies: | |
| needs: [constants, check_if_wheel_build_required, determine_runner] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python_version: ["3.10"] | |
| container_img: ["manylinux_2_28_x86_64"] | |
| name: Build Dependencies (Python ${{ matrix.python_version }}) | |
| runs-on: ${{ needs.determine_runner.outputs.runner_group }} | |
| container: quay.io/pypa/${{ matrix.container_img }} | |
| if: needs.check_if_wheel_build_required.outputs.build-wheels == 'true' | |
| steps: | |
| - name: Checkout Catalyst repo | |
| uses: actions/checkout@v4 | |
| - name: Set Ownership in Container | |
| run: | | |
| # To fix the git issue with the owner of the checkout dir | |
| chown -R $(id -u):$(id -g) $PWD | |
| # Cache external project sources | |
| # Note that these caches will not be the same as for our main check-catalyst action, since | |
| # GH doesn't support using caches across un-/containerized actions (those with `container_img`). | |
| - name: Cache LLVM Source | |
| id: cache-llvm-source | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ github.workspace }}/mlir/llvm-project | |
| key: llvm-${{ needs.constants.outputs.llvm_version }}-container-source | |
| enableCrossOsArchive: True | |
| - name: Cache MHLO Source | |
| id: cache-mhlo-source | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ github.workspace }}/mlir/mlir-hlo | |
| key: mhlo-${{ needs.constants.outputs.mhlo_version }}-container-source | |
| enableCrossOsArchive: True | |
| - name: Cache Enzyme Source | |
| id: cache-enzyme-source | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ github.workspace }}/mlir/Enzyme | |
| key: enzyme-${{ needs.constants.outputs.enzyme_version }}-container-source | |
| enableCrossOsArchive: True | |
| - name: Clone LLVM Submodule | |
| if: steps.cache-llvm-source.outputs.cache-hit != 'true' | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: llvm/llvm-project | |
| ref: ${{ needs.constants.outputs.llvm_version }} | |
| path: ${{ github.workspace }}/mlir/llvm-project | |
| - name: Clone MHLO Submodule | |
| if: steps.cache-mhlo-source.outputs.cache-hit != 'true' | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: tensorflow/mlir-hlo | |
| ref: ${{ needs.constants.outputs.mhlo_version }} | |
| path: ${{ github.workspace }}/mlir/mlir-hlo | |
| - name: Clone Enzyme Submodule | |
| if: steps.cache-enzyme-source.outputs.cache-hit != 'true' | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: EnzymeAD/Enzyme | |
| ref: ${{ needs.constants.outputs.enzyme_version }} | |
| path: ${{ github.workspace }}/mlir/Enzyme | |
| # Cache external project builds | |
| - name: Restore LLVM Build | |
| id: cache-llvm-build | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/llvm-build | |
| key: ${{ matrix.container_img }}-llvm-${{ needs.constants.outputs.llvm_version }}-${{matrix.python_version}}-wheel-build | |
| - name: Restore MHLO Build | |
| id: cache-mhlo-build | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/mhlo-build | |
| key: ${{ matrix.container_img }}-mhlo-${{ needs.constants.outputs.mhlo_version }}-wheel-build | |
| lookup-only: True | |
| - name: Restore Enzyme Build | |
| id: cache-enzyme-build | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/enzyme-build | |
| key: ${{ matrix.container_img }}-enzyme-${{ needs.constants.outputs.llvm_version }}-${{ needs.constants.outputs.enzyme_version }}-wheel-build | |
| lookup-only: True | |
| - name: Install dependencies (AlmaLinux) | |
| if: | | |
| steps.cache-llvm-build.outputs.cache-hit != 'true' || | |
| steps.cache-mhlo-build.outputs.cache-hit != 'true' || | |
| steps.cache-enzyme-build.outputs.cache-hit != 'true' | |
| run: | | |
| # Reduce wait time for repos not responding | |
| cat /etc/dnf.conf | sed "s/\[main\]/\[main\]\ntimeout=5/g" > /etc/dnf.conf | |
| dnf update -y && dnf install -y libzstd-devel gcc-toolset-12 | |
| # Update env vars valid for all tasks of this job | |
| echo '/opt/rh/gcc-toolset-12/root/usr/bin' >> $GITHUB_PATH | |
| - name: Install Dependencies (Python) | |
| run: | | |
| python${{ matrix.python_version }} -m pip install numpy nanobind pybind11 PyYAML cmake ninja | |
| # Add cmake and ninja to the PATH env var | |
| PYTHON_BINS=$(find /opt/_internal/cpython-${{ matrix.python_version }}.*/bin -maxdepth 1 -type d | tr '\n' ':' | sed 's/:$//') | |
| echo $PYTHON_BINS >> $GITHUB_PATH | |
| # LLD is required for MHLO builds. | |
| # (Don't forget to add the build directory to PATH in subsequent steps, so | |
| # other tools can find it, in particular collect2 invoked by gcc.) | |
| - name: Build LLVM / MLIR | |
| if: steps.cache-llvm-build.outputs.cache-hit != 'true' | |
| run: | | |
| export PATH=$GITHUB_WORKSPACE/llvm-build/bin:$PATH | |
| PYTHON=$(which python${{ matrix.python_version }}) \ | |
| C_COMPILER=$(which gcc) \ | |
| CXX_COMPILER=$(which g++) \ | |
| LLVM_BUILD_DIR="$GITHUB_WORKSPACE/llvm-build" \ | |
| LLVM_PROJECTS="lld;mlir" \ | |
| LLVM_TARGETS="lld check-mlir" \ | |
| ENABLE_ZLIB=FORCE_ON \ | |
| ENABLE_LLD=OFF \ | |
| make llvm | |
| - name: Save LLVM Build | |
| id: save-llvm-build | |
| if: steps.cache-llvm-build.outputs.cache-hit != 'true' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: ${{ github.workspace }}/llvm-build | |
| key: ${{ matrix.container_img }}-llvm-${{ needs.constants.outputs.llvm_version }}-${{matrix.python_version}}-wheel-build | |
| - name: Build MHLO Dialect | |
| if: steps.cache-mhlo-build.outputs.cache-hit != 'true' | |
| # building with LLD is a strong requirement for mhlo | |
| run: | | |
| export PATH=$GITHUB_WORKSPACE/llvm-build/bin:$PATH | |
| export TARGET_FILE=mlir/mlir-hlo/mhlo/transforms/CMakeLists.txt | |
| export PATCH_FILE=mlir/patches/mhlo-Add-PassesIncGen-in-transforms-CMakeList.patch | |
| if patch --dry-run -p1 -N $TARGET_FILE $PATCH_FILE > /dev/null 2>&1; then patch -p1 $TARGET_FILE $PATCH_FILE; fi | |
| cmake -S mlir/mlir-hlo -B $GITHUB_WORKSPACE/mhlo-build -G Ninja \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DLLVM_ENABLE_ASSERTIONS=ON \ | |
| -DMLIR_DIR="$GITHUB_WORKSPACE/llvm-build/lib/cmake/mlir" \ | |
| -DPython3_EXECUTABLE=$(which python${{ matrix.python_version }}) \ | |
| -DLLVM_ENABLE_ZLIB=FORCE_ON \ | |
| -DLLVM_ENABLE_ZSTD=OFF \ | |
| -DCMAKE_CXX_VISIBILITY_PRESET=default \ | |
| -DLLVM_ENABLE_LLD=ON | |
| LIT_FILTER_OUT="chlo_legalize_to_mhlo" cmake --build $GITHUB_WORKSPACE/mhlo-build --target check-mlir-hlo | |
| - name: Save MHLO Build | |
| id: save-mhlo-build | |
| if: steps.cache-mhlo-build.outputs.cache-hit != 'true' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: ${{ github.workspace }}/mhlo-build | |
| key: ${{ matrix.container_img }}-mhlo-${{ needs.constants.outputs.mhlo_version }}-wheel-build | |
| - name: Build Enzyme | |
| if: steps.cache-enzyme-build.outputs.cache-hit != 'true' | |
| run: | | |
| export PATH=$GITHUB_WORKSPACE/llvm-build/bin:$PATH | |
| cmake -S mlir/Enzyme/enzyme -B $GITHUB_WORKSPACE/enzyme-build -G Ninja \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DLLVM_DIR="$GITHUB_WORKSPACE/llvm-build/lib/cmake/llvm" \ | |
| -DENZYME_STATIC_LIB=ON \ | |
| -DCMAKE_CXX_VISIBILITY_PRESET=default \ | |
| -DCMAKE_CXX_FLAGS="-fuse-ld=lld" | |
| cmake --build $GITHUB_WORKSPACE/enzyme-build --target EnzymeStatic-19 | |
| - name: Save Enzyme Build | |
| id: save-enzyme-build | |
| if: steps.cache-enzyme-build.outputs.cache-hit != 'true' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: ${{ github.workspace }}/enzyme-build | |
| key: ${{ matrix.container_img }}-enzyme-${{ needs.constants.outputs.llvm_version }}-${{ needs.constants.outputs.enzyme_version }}-wheel-build | |
| catalyst-linux-wheels-x86-64: | |
| needs: [constants, build-dependencies, determine_runner] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python_version: ${{ fromJSON(needs.constants.outputs.python_versions) }} | |
| container_img: ["manylinux_2_28_x86_64"] | |
| name: Build Wheels (Python ${{ matrix.python_version }}) | |
| runs-on: ${{ needs.determine_runner.outputs.runner_group }} | |
| container: quay.io/pypa/${{ matrix.container_img }} | |
| steps: | |
| - name: Checkout Catalyst repo | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies (AlmaLinux) | |
| run: | | |
| # Reduce wait time for repos not responding | |
| cat /etc/dnf.conf | sed "s/\[main\]/\[main\]\ntimeout=5/g" > /etc/dnf.conf | |
| dnf update -y && dnf install -y openmpi-devel libzstd-devel gcc-toolset-12 | |
| # Update env vars valid for all tasks of this job | |
| echo '/opt/rh/gcc-toolset-12/root/usr/bin' >> $GITHUB_PATH | |
| - name: Install Dependencies (Python) | |
| run: | | |
| python${{ matrix.python_version }} -m pip install numpy nanobind pybind11 PyYAML cmake ninja | |
| # Add cmake and ninja to the PATH env var | |
| PYTHON_BINS=$(find /opt/_internal/cpython-${{ matrix.python_version }}.*/bin -maxdepth 1 -type d | tr '\n' ':' | sed 's/:$//') | |
| echo $PYTHON_BINS >> $GITHUB_PATH | |
| - name: Get Cached LLVM Source | |
| id: cache-llvm-source | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/mlir/llvm-project | |
| key: llvm-${{ needs.constants.outputs.llvm_version }}-container-source | |
| enableCrossOsArchive: True | |
| fail-on-cache-miss: True | |
| - name: Get Cached LLVM Build | |
| id: cache-llvm-build | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/llvm-build | |
| key: ${{ matrix.container_img }}-llvm-${{ needs.constants.outputs.llvm_version }}-3.10-wheel-build | |
| fail-on-cache-miss: True | |
| - name: Get Cached MHLO Source | |
| id: cache-mhlo-source | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/mlir/mlir-hlo | |
| key: mhlo-${{ needs.constants.outputs.mhlo_version }}-container-source | |
| enableCrossOsArchive: True | |
| fail-on-cache-miss: True | |
| - name: Get Cached MHLO Build | |
| id: cache-mhlo-build | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/mhlo-build | |
| key: ${{ matrix.container_img }}-mhlo-${{ needs.constants.outputs.mhlo_version }}-wheel-build | |
| fail-on-cache-miss: True | |
| - name: Get Cached Enzyme Source | |
| id: cache-enzyme-source | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/mlir/Enzyme | |
| key: enzyme-${{ needs.constants.outputs.enzyme_version }}-container-source | |
| enableCrossOsArchive: True | |
| fail-on-cache-miss: True | |
| - name: Get Cached Enzyme Build | |
| id: cache-enzyme-build | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/enzyme-build | |
| key: ${{ matrix.container_img }}-enzyme-${{ needs.constants.outputs.llvm_version }}-${{ needs.constants.outputs.enzyme_version }}-wheel-build | |
| fail-on-cache-miss: True | |
| # Build Catalyst-Runtime | |
| - name: Build Catalyst-Runtime | |
| run: | | |
| cmake -S runtime -B $GITHUB_WORKSPACE/runtime-build -G Ninja \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DCMAKE_LIBRARY_OUTPUT_DIRECTORY="$GITHUB_WORKSPACE/runtime-build/lib" \ | |
| -DPython_EXECUTABLE=$(which python${{ matrix.python_version }}) \ | |
| -DENABLE_OPENQASM=ON | |
| cmake --build $GITHUB_WORKSPACE/runtime-build --target rt_capi rtd_openqasm rtd_null_qubit | |
| # Build OQC-Runtime | |
| - name: Build OQC-Runtime | |
| run: | | |
| C_COMPILER=$(which gcc) \ | |
| CXX_COMPILER=$(which g++) \ | |
| OQC_BUILD_DIR="$GITHUB_WORKSPACE/oqc-build" \ | |
| RT_BUILD_DIR="$GITHUB_WORKSPACE/runtime-build" \ | |
| PYTHON=$(which python${{ matrix.python_version }}) \ | |
| make oqc | |
| # Build OQD-Runtime | |
| - name: Build OQD-Runtime | |
| run: | | |
| C_COMPILER=$(which gcc) \ | |
| CXX_COMPILER=$(which g++) \ | |
| OQD_BUILD_DIR="$GITHUB_WORKSPACE/oqd-build" \ | |
| RT_BUILD_DIR="$GITHUB_WORKSPACE/runtime-build" \ | |
| PYTHON=$(which python${{ matrix.python_version }}) \ | |
| make oqd | |
| # Build Quantum and Gradient Dialects | |
| - name: Build MLIR Dialects | |
| run: | | |
| export PATH=$GITHUB_WORKSPACE/llvm-build/bin:$PATH | |
| cmake -S mlir -B $GITHUB_WORKSPACE/quantum-build -G Ninja \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DLLVM_ENABLE_ASSERTIONS=ON \ | |
| -DQUANTUM_ENABLE_BINDINGS_PYTHON=ON \ | |
| -DPython3_EXECUTABLE=$(which python${{ matrix.python_version }}) \ | |
| -DPython3_NumPy_INCLUDE_DIRS=$(python${{ matrix.python_version }} -c "import numpy as np; print(np.get_include())") \ | |
| -DMLIR_DIR="$GITHUB_WORKSPACE/llvm-build/lib/cmake/mlir" \ | |
| -DMHLO_DIR="$GITHUB_WORKSPACE/mhlo-build/lib/cmake/mlir-hlo" \ | |
| -DMHLO_BINARY_DIR="$GITHUB_WORKSPACE/mhlo-build/bin" \ | |
| -DEnzyme_DIR="$GITHUB_WORKSPACE/enzyme-build" \ | |
| -DENZYME_SRC_DIR="$GITHUB_WORKSPACE/mlir/Enzyme" \ | |
| -DLLVM_ENABLE_ZLIB=FORCE_ON \ | |
| -DLLVM_ENABLE_ZSTD=OFF \ | |
| -DLLVM_ENABLE_LLD=ON | |
| cmake --build $GITHUB_WORKSPACE/quantum-build --target check-dialects catalyst-cli | |
| - name: Build Plugin wheel | |
| # Run only on Thursday at the given time | |
| if: github.event.schedule == '35 4 * * 4' | |
| run: | | |
| MLIR_DIR="$GITHUB_WORKSPACE/llvm-build/lib/cmake/mlir" \ | |
| LLVM_BUILD_DIR="$GITHUB_WORKSPACE/llvm-build" \ | |
| make plugin-wheel | |
| - name: Build wheel | |
| run: | | |
| PYTHON=python${{ matrix.python_version }} \ | |
| LLVM_BUILD_DIR="$GITHUB_WORKSPACE/llvm-build" \ | |
| MHLO_BUILD_DIR="$GITHUB_WORKSPACE/mhlo-build" \ | |
| DIALECTS_BUILD_DIR="$GITHUB_WORKSPACE/quantum-build" \ | |
| RT_BUILD_DIR="$GITHUB_WORKSPACE/runtime-build" \ | |
| OQC_BUILD_DIR="$GITHUB_WORKSPACE/oqc-build" \ | |
| OQD_BUILD_DIR="$GITHUB_WORKSPACE/oqd-build" \ | |
| ENZYME_BUILD_DIR="$GITHUB_WORKSPACE/enzyme-build" \ | |
| make wheel | |
| - name: Repair wheel using auditwheel | |
| run: | | |
| # exclude libopenblas as we rely on the openblas/lapack library shipped by scipy | |
| auditwheel repair dist/*.whl -w ./wheel --no-update-tags --exclude libopenblasp-r0-23e5df77.3.21.dev.so | |
| - name: Upload Wheel Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: catalyst-manylinux_2_28_x86_64-wheel-py-${{ matrix.python_version }}.zip | |
| path: ${{ github.workspace }}/wheel/ | |
| retention-days: 14 | |
| - name: Upload Standalone Plugin Wheel Artifact | |
| # Run only on Thursday at the given time | |
| if: github.event.schedule == '35 4 * * 4' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: standalone-plugin-manylinux_2_28_x86_64-wheel-py-${{ matrix.python_version }}.zip | |
| path: ${{ github.workspace }}/standalone_plugin_wheel/dist | |
| retention-days: 14 | |
| test-wheels: | |
| needs: [constants, catalyst-linux-wheels-x86-64, determine_runner] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python_version: ${{ fromJSON(needs.constants.outputs.python_versions) }} | |
| # To check all wheels for supported python3 versions | |
| name: Test Wheels (Python ${{ matrix.python_version }}) on Linux x86 | |
| runs-on: ${{ needs.determine_runner.outputs.runner_group }} | |
| steps: | |
| - name: Checkout Catalyst repo | |
| uses: actions/checkout@v4 | |
| - name: Download Wheel Artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: catalyst-manylinux_2_28_x86_64-wheel-py-${{ matrix.python_version }}.zip | |
| path: ${{ github.workspace }}/dist | |
| - name: Download Standalone Plugin Wheel Artifact | |
| # Run only on Thursday at the given time | |
| if: github.event.schedule == '35 4 * * 4' | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: standalone-plugin-manylinux_2_28_x86_64-wheel-py-${{ matrix.python_version }}.zip | |
| path: ${{ github.workspace }}/standalone_plugin_wheel/wheel | |
| - name: Set up Python ${{ matrix.python_version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python_version }} | |
| - name: Install Python dependencies | |
| run: | | |
| python${{ matrix.python_version }} -m pip install pytest pytest-xdist pytest-mock | |
| - name: Install PennyLane Plugins | |
| run: | | |
| python${{ matrix.python_version }} -m pip install PennyLane-Lightning-Kokkos | |
| python${{ matrix.python_version }} -m pip install 'amazon-braket-pennylane-plugin>=1.31.0' | |
| - name: Install OQC client | |
| run: | | |
| python${{ matrix.python_version }} -m pip install oqc-qcaas-client | |
| - name: Install Catalyst | |
| run: | | |
| python${{ matrix.python_version }} -m pip install dist/*.whl --extra-index-url https://test.pypi.org/simple | |
| - name: Install Standalone Plugin | |
| # Run only on Thursday at the given time (TODO: set comparison to == before merging) | |
| if: github.event.schedule == '35 4 * * 4' | |
| run: | | |
| python${{ matrix.python_version }} -m pip install standalone_plugin_wheel/wheel/*.whl --no-deps | |
| - name: Run Python Pytest Tests | |
| run: | | |
| python${{ matrix.python_version }} -m pytest frontend/test/pytest -n auto | |
| python${{ matrix.python_version }} -m pytest frontend/test/pytest --backend="lightning.kokkos" -n auto | |
| python${{ matrix.python_version }} -m pytest frontend/test/async_tests | |
| python${{ matrix.python_version }} -m pytest frontend/test/pytest --runbraket=LOCAL -n auto | |
| python${{ matrix.python_version }} -m pytest frontend/test/test_oqc/oqc -n auto | |
| - name: Run Standalone Plugin Tests | |
| # Run only on Thursday at the given time | |
| if: github.event.schedule == '35 4 * * 4' | |
| run: | | |
| python${{ matrix.python_version }} -m pytest standalone_plugin_wheel/standalone_plugin/test -n auto |