Rework CUDA/native-library setup and diagnostics #265
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: Python package | |
| on: | |
| push: {} | |
| pull_request: | |
| branches: [ main ] | |
| paths: | |
| - '.github/workflows/python-package.yml' | |
| - 'bitsandbytes/**' | |
| - 'csrc/**' | |
| - 'include/**' | |
| - 'tests/**' | |
| - 'CMakeLists.txt' | |
| - 'requirements*.txt' | |
| - 'setup.py' | |
| - 'pyproject.toml' | |
| - 'pytest.ini' | |
| release: | |
| types: [ published ] | |
| workflow_dispatch: {} # Allow manual trigger | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| ## | |
| # This job matrix builds the non-CUDA versions of the libraries for all supported platforms. | |
| ## | |
| build-shared-libs: | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| arch: [x86_64, aarch64] | |
| exclude: | |
| - os: windows-latest # This probably requires arm64 Windows agents | |
| arch: aarch64 | |
| runs-on: ${{ matrix.os }} # One day, we could run them on native agents. Azure supports this now but it's planned only for Q3 2023 for hosted agents | |
| steps: | |
| # Check out code | |
| - uses: actions/checkout@v4 | |
| # On Linux we use CMake within Docker | |
| - name: Setup cmake | |
| uses: jwlawson/[email protected] | |
| with: | |
| cmake-version: '3.26.x' | |
| - name: Setup MSVC | |
| if: startsWith(matrix.os, 'windows') | |
| #uses: microsoft/[email protected] # to use msbuild | |
| uses: ilammy/[email protected] # to use cl | |
| # Compile C++ code | |
| - name: Build C++ | |
| shell: bash | |
| run: | | |
| set -ex | |
| build_os=${{ matrix.os }} | |
| build_arch=${{ matrix.arch }} | |
| if [ ${build_os:0:6} == ubuntu -a ${build_arch} == aarch64 ]; then | |
| # Allow cross-compile on aarch64 | |
| sudo apt-get update | |
| sudo apt-get install -y gcc-aarch64-linux-gnu binutils-aarch64-linux-gnu g++-aarch64-linux-gnu | |
| cmake -DCMAKE_C_COMPILER=aarch64-linux-gnu-gcc -DCMAKE_CXX_COMPILER=aarch64-linux-gnu-g++ -DCOMPUTE_BACKEND=cpu . | |
| elif [ ${build_os:0:5} == macos -a ${build_arch} == aarch64 ]; then | |
| cmake -DCMAKE_OSX_ARCHITECTURES=arm64 -DCOMPUTE_BACKEND=cpu . | |
| else | |
| cmake -DCOMPUTE_BACKEND=cpu . | |
| fi | |
| cmake --build . --config Release | |
| mkdir -p output/${{ matrix.os }}/${{ matrix.arch }} | |
| ( shopt -s nullglob && cp bitsandbytes/*.{so,dylib,dll} output/${{ matrix.os }}/${{ matrix.arch }}/ ) | |
| - name: Upload build artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: shared_library_${{ matrix.os }}_${{ matrix.arch }} | |
| path: output/* | |
| retention-days: 7 | |
| ## | |
| # This job matrix builds the CUDA versions of the libraries for platforms that support CUDA (Linux x64/aarch64 + Windows x64) | |
| ## | |
| build-shared-libs-cuda: | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| arch: [x86_64, aarch64] | |
| cuda_version: ["11.7.1", "11.8.0", "12.0.1", "12.1.1", "12.2.2", "12.3.2"] | |
| exclude: | |
| - os: windows-latest # This probably requires arm64 Windows agents | |
| arch: aarch64 | |
| - os: ubuntu-latest # Temporary. Takes too long, not ready yet. | |
| arch: aarch64 | |
| runs-on: ${{ matrix.os }} # One day, we could run them on native agents. Azure supports this now but it's planned only for Q3 2023 for hosted agents | |
| steps: | |
| # Check out code | |
| - uses: actions/checkout@v4 | |
| # Linux: We use Docker to build cross platform Cuda (aarch64 is built in emulation) | |
| - name: Set up Docker multiarch | |
| if: startsWith(matrix.os, 'ubuntu') | |
| uses: docker/setup-qemu-action@v2 | |
| # On Linux we use CMake within Docker | |
| - name: Setup cmake | |
| if: ${{ !startsWith(matrix.os, 'linux') }} | |
| uses: jwlawson/[email protected] | |
| with: | |
| cmake-version: '3.26.x' | |
| # Windows: We install Cuda on the agent (slow) | |
| - uses: Jimver/[email protected] | |
| if: startsWith(matrix.os, 'windows') | |
| id: cuda-toolkit | |
| with: | |
| cuda: ${{ matrix.cuda_version }} | |
| method: 'network' | |
| sub-packages: '["nvcc","cudart","cusparse","cublas","thrust","nvrtc_dev","cublas_dev","cusparse_dev"]' | |
| linux-local-args: '["--toolkit"]' | |
| use-github-cache: false | |
| - name: Setup MSVC | |
| if: startsWith(matrix.os, 'windows') | |
| #uses: microsoft/[email protected] # to use msbuild | |
| uses: ilammy/[email protected] # to use cl | |
| # Compile C++ code | |
| - name: Build C++ | |
| shell: bash | |
| run: | | |
| set -ex | |
| build_os=${{ matrix.os }} | |
| build_arch=${{ matrix.arch }} | |
| build_capability="50;52;60;61;70;75;80;86;89;90" | |
| [[ "${{ matrix.cuda_version }}" == 11.7.* ]] && build_capability=${build_capability%??????} | |
| [[ "${{ matrix.cuda_version }}" == 11.8.* ]] && build_capability=${build_capability%???} | |
| [[ "${{ matrix.os }}" = windows-* ]] && python3 -m pip install ninja | |
| for NO_CUBLASLT in ON OFF; do | |
| if [ ${build_os:0:6} == ubuntu ]; then | |
| image=nvidia/cuda:${{ matrix.cuda_version }}-devel-ubuntu22.04 | |
| echo "Using image $image" | |
| docker run --platform linux/$build_arch -i -w /src -v $PWD:/src $image sh -c \ | |
| "apt-get update \ | |
| && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends cmake \ | |
| && cmake -DCOMPUTE_BACKEND=cuda -DCOMPUTE_CAPABILITY=\"${build_capability}\" -DNO_CUBLASLT=${NO_CUBLASLT} . \ | |
| && cmake --build ." | |
| else | |
| cmake -G Ninja -DCOMPUTE_BACKEND=cuda -DCOMPUTE_CAPABILITY="${build_capability}" -DNO_CUBLASLT=${NO_CUBLASLT} -DCMAKE_BUILD_TYPE=Release -S . | |
| cmake --build . --config Release | |
| fi | |
| done | |
| mkdir -p output/${{ matrix.os }}/${{ matrix.arch }} | |
| ( shopt -s nullglob && cp bitsandbytes/*.{so,dylib,dll} output/${{ matrix.os }}/${{ matrix.arch }}/ ) | |
| - name: Upload build artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: shared_library_cuda_${{ matrix.os }}_${{ matrix.arch }}_${{ matrix.cuda_version }} | |
| path: output/* | |
| retention-days: 7 | |
| build-wheels: | |
| needs: | |
| - build-shared-libs | |
| - build-shared-libs-cuda | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| # The specific Python version is irrelevant in this context as we are only packaging non-C extension | |
| # code. This ensures compatibility across Python versions, including Python 3.8, as compatibility is | |
| # dictated by the packaged code itself, not the Python version used for packaging. | |
| python-version: ["3.10"] | |
| arch: [x86_64, aarch64] | |
| exclude: | |
| - os: windows-latest # This probably requires arm64 Windows agents | |
| arch: aarch64 | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| # Check out code | |
| - uses: actions/checkout@v4 | |
| # Download shared libraries | |
| - name: Download build artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| merge-multiple: true | |
| pattern: "shared_library*_${{ matrix.os }}_${{ matrix.arch }}*" | |
| path: output/ | |
| - name: Copy correct platform shared library | |
| shell: bash | |
| run: | | |
| ls -lR output/ | |
| cp output/${{ matrix.os }}/${{ matrix.arch }}/* bitsandbytes/ | |
| # Set up the Python version needed | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: pip | |
| - name: Install build package | |
| shell: bash | |
| run: pip install build | |
| - name: Install Python test dependencies | |
| shell: bash | |
| run: pip install -r requirements-ci.txt | |
| # TODO: How to run CUDA tests on GitHub actions? | |
| #- name: Run unit tests | |
| # if: ${{ matrix.arch == 'x86_64' }} # Tests are too slow to run in emulation. Wait for real aarch64 agents | |
| # run: | | |
| # PYTHONPATH=. pytest --log-cli-level=DEBUG tests | |
| - name: Build wheel | |
| shell: bash | |
| run: python -m build . | |
| - name: Determine and Set Platform Tag, then Tag Wheel | |
| shell: bash | |
| run: | | |
| PLATFORM_TAG=$(python scripts/set_platform_tag.py ${{ matrix.arch }}) | |
| echo "PLATFORM_TAG=$PLATFORM_TAG" | |
| wheel tags --remove --abi-tag=none --python-tag=py3 --platform-tag=$PLATFORM_TAG dist/bitsandbytes-*.whl | |
| - name: Upload build artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: bdist_wheel_${{ matrix.os }}_${{ matrix.arch }} | |
| path: dist/bitsandbytes-*.whl | |
| retention-days: 7 |