-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Migrate CircleCI to GitHub Actions #2716
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: 'Build CUDA wheel' | ||
| description: 'Build CUDA wheel' | ||
|
|
||
| inputs: | ||
| nvcc-location: | ||
| description: 'Location of nvcc compiler' | ||
| required: true | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Build package | ||
| shell: bash | ||
| env: | ||
| MLX_BUILD_STAGE: 2 | ||
| CMAKE_ARGS: -DMLX_BUILD_CUDA=ON -DCMAKE_CUDA_COMPILER=${{ inputs.nvcc-location }} | ||
| run: | | ||
| pip install auditwheel build patchelf setuptools | ||
| python setup.py clean --all | ||
| python -m build -w | ||
|
|
||
| if [ -f "python/scripts/repair_cuda.sh" ]; then | ||
| bash python/scripts/repair_cuda.sh | ||
| fi |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| name: 'Build and Test with CUDA' | ||
| description: 'Build and test MLX with CUDA' | ||
|
|
||
| inputs: | ||
| build-type: | ||
| description: 'Build type (debug, release)' | ||
| required: false | ||
| default: 'debug' | ||
| run-tests: | ||
| description: 'Whether to run tests' | ||
| required: false | ||
| default: 'true' | ||
| nvcc-location: | ||
| description: 'Location of nvcc compiler' | ||
| required: true | ||
| default: '/usr/local/cuda-12.9/bin/nvcc' | ||
| # this value is dependent on the CUDA tools installed in the setup-linux workflow | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Install Python package | ||
| shell: bash | ||
| env: | ||
| DEBUG: 1 | ||
| CMAKE_ARGS: -DMLX_BUILD_CUDA=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_CUDA_COMPILER=${{ inputs.nvcc-location }} | ||
| run: pip install -e ".[dev]" -v | ||
|
|
||
| - name: Check if build actually worked | ||
| shell: bash | ||
| run: python -c "import mlx.core" | ||
|
|
||
| - name: Run Python tests - CPU | ||
| if: inputs.run-tests == 'true' | ||
| shell: bash | ||
| env: | ||
| LOW_MEMORY: 1 | ||
| DEVICE: cpu | ||
| run: python -m unittest discover python/tests -v | ||
|
|
||
| - name: Run Python tests - GPU | ||
| if: inputs.run-tests == 'true' | ||
| shell: bash | ||
| env: | ||
| LOW_MEMORY: 1 | ||
| DEVICE: gpu | ||
| run: python -m tests discover python/tests -v | ||
|
|
||
| - name: Build CPP only | ||
| if: inputs.build-type == 'debug' | ||
| shell: bash | ||
| run: | | ||
| cmake . -B build \ | ||
| -DMLX_BUILD_CUDA=ON \ | ||
| -DCMAKE_CUDA_COMPILER=${{ inputs.nvcc-location }} \ | ||
| -DCMAKE_BUILD_TYPE=DEBUG | ||
| cmake --build build -j $(nproc) | ||
|
|
||
| - name: Run CPP tests | ||
| if: ${{ inputs.build-type == 'debug' && inputs.run-tests == 'true' }} | ||
| shell: bash | ||
| run: ./build/tests/tests -sfe="*fft_tests.cpp,*linalg_tests.cpp" | ||
|
|
||
| - name: Build Python package | ||
| if: inputs.build-type == 'release' | ||
| uses: ./.github/actions/build-cuda-release | ||
| with: | ||
| nvcc-location: ${{ inputs.nvcc-location }} |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: 'Build Documentation' | ||
| description: 'Build documentation on a mac' | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Setup machine | ||
| uses: ./.github/actions/setup-macos | ||
|
|
||
| - name: Install dependencies | ||
| shell: sh | ||
| run: | | ||
| brew install doxygen | ||
| uv pip install --upgrade pip cmake | ||
| uv pip install -r docs/requirements.txt | ||
| uv pip install . -v | ||
|
|
||
| - name: Build documentation | ||
| shell: bash | ||
| run: | | ||
| source .venv/bin/activate | ||
| cd docs | ||
| doxygen | ||
| make html O=-W | ||
|
|
||
| - name: Create artifact tar | ||
| shell: sh | ||
| run: tar -cf artifact.tar --cd docs/build/html -L . | ||
|
|
||
| # Do it manually because upload-pages-artifact requires gtar | ||
| - name: Upload artifact | ||
| id: upload-artifact | ||
| uses: actions/upload-artifact@v5 | ||
| with: | ||
| name: github-pages | ||
| path: artifact.tar | ||
| retention-days: 1 | ||
| if-no-files-found: error |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| name: 'Build and Test on Linux' | ||
| description: 'Build and test MLX on Linux' | ||
|
|
||
| inputs: | ||
| build-type: | ||
| description: 'Build type' | ||
| required: false | ||
| default: 'debug' | ||
| type: choice | ||
| options: | ||
| - debug | ||
| - release | ||
| run-tests: | ||
| description: 'Whether to run tests' | ||
| required: false | ||
| default: 'true' | ||
| type: boolean | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Set DEBUG | ||
| shell: sh | ||
| if: inputs.build-type == 'debug' | ||
| run: echo "DEBUG=1" >> $GITHUB_ENV | ||
|
|
||
| - name: Install Python package | ||
| shell: sh | ||
| env: | ||
| CMAKE_ARGS: "-DCMAKE_COMPILE_WARNING_AS_ERROR=ON" | ||
| run: pip install -e ".[dev]" -v | ||
|
|
||
| - name: Generate package stubs | ||
| shell: sh | ||
| run: | | ||
| pip install typing_extensions | ||
| python setup.py generate_stubs | ||
|
|
||
| - name: Run Python tests | ||
| if: inputs.run-tests == 'true' | ||
| shell: bash | ||
| run: | | ||
| python -m unittest discover python/tests -v | ||
| mpirun --bind-to none --allow-run-as-root -host localhost:8 -np 8 python python/tests/mpi_test_distributed.py | ||
| mlx.launch --verbose -n 8 python/tests/ring_test_distributed.py -v 2> >(tee -a stderr.log >&2) | ||
| if grep -Fq '[WARN]' stderr.log ; then | ||
| grep -F '[WARN]' stderr.log | ||
| echo "Distributed ring test failed"; | ||
| exit 1; | ||
| fi | ||
|
|
||
| - name: Build CPP only | ||
| if: inputs.build-type == 'debug' | ||
| shell: bash | ||
| run: | | ||
| mkdir -p build && cd build | ||
| cmake .. -DMLX_BUILD_METAL=OFF -DCMAKE_BUILD_TYPE=DEBUG | ||
| make -j $(nproc) | ||
|
|
||
| - name: Run CPP tests | ||
| if: ${{ inputs.build-type == 'debug' && inputs.run-tests == 'true' }} | ||
| shell: sh | ||
| run: ./build/tests/tests | ||
|
|
||
| - name: Build Python package | ||
| if: inputs.build-type == 'release' | ||
| shell: bash | ||
| run: | | ||
| pip install auditwheel patchelf build | ||
| python setup.py clean --all | ||
| MLX_BUILD_STAGE=1 python -m build -w | ||
| if [ -f "python/scripts/repair_linux.sh" ]; then | ||
| bash python/scripts/repair_linux.sh | ||
| fi | ||
|
|
||
| python setup.py clean --all | ||
| MLX_BUILD_STAGE=2 python -m build -w | ||
| auditwheel repair dist/mlx_cpu*.whl --plat manylinux_2_35_x86_64 |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: 'Build macOS release' | ||
| description: 'Build MLX releases macOS' | ||
|
|
||
| inputs: | ||
| macos-target: | ||
| description: 'macOS build target' | ||
| required: false | ||
| default: '15.0' | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Build Python package(s) | ||
| shell: bash | ||
| env: | ||
| MACOSX_DEPLOYMENT_TARGET: ${{ inputs.macos-target }} | ||
| run: | | ||
| uv pip install build | ||
| uv run --no-project setup.py clean --all | ||
| MLX_BUILD_STAGE=1 uv run -m build -w | ||
| uv run --no-project setup.py clean --all | ||
| MLX_BUILD_STAGE=2 uv run -m build -w |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| name: 'Build and Test on macOS' | ||
| description: 'Build and test MLX on macOS' | ||
|
|
||
| inputs: | ||
| build-type: | ||
| description: 'Build type (debug, release)' | ||
| required: false | ||
| default: 'debug' | ||
| type: choice | ||
| options: | ||
| - debug | ||
| - release | ||
| run-tests: | ||
| description: 'Whether to run tests' | ||
| required: false | ||
| default: 'true' | ||
| build-jit: | ||
| description: 'Whether to build with JIT' | ||
| required: false | ||
| default: 'true' | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Install dependencies | ||
| shell: sh | ||
| env: | ||
| DEBUG: 1 | ||
| DEV_RELEASE: 1 | ||
| run: | | ||
| uv pip install --upgrade pip cmake setuptools | ||
| uv pip install nanobind==2.4.0 \ | ||
| numpy torch tensorflow unittest-xml-reporting | ||
| uv pip install -e . -v | ||
|
|
||
| - name: Generate package stubs | ||
| shell: bash | ||
| run: | | ||
| uv pip install typing_extensions | ||
| uv run --no-project setup.py generate_stubs | ||
|
|
||
| - name: Run Python tests | ||
| if: inputs.run-tests == 'true' | ||
| shell: bash | ||
| env: | ||
| LOW_MEMORY: 1 | ||
| run: | | ||
| DEVICE=cpu uv run -m xmlrunner discover -v python/tests -o test-results/cpu | ||
| DEVICE=gpu METAL_DEVICE_WRAPPER_TYPE=1 METAL_DEBUG_ERROR_MODE=0 uv run -m xmlrunner discover -v python/tests -o test-results/gpu | ||
| mpirun --bind-to none -host localhost:8 -np 8 -x DYLD_LIBRARY_PATH=/opt/homebrew/lib/ python python/tests/mpi_test_distributed.py | ||
| mlx.launch --verbose -n 8 python/tests/ring_test_distributed.py -v 2> >(tee -a stderr.log >&2) | ||
| if $(grep "\[WARN\]" stderr.log); then echo "Distributed ring test failed"; exit 1; fi | ||
|
|
||
| - name: Build example extension | ||
| if: inputs.run-tests == 'true' | ||
| shell: bash | ||
| run: | | ||
| cd examples/extensions | ||
| uv pip install -r requirements.txt | ||
| uv run --no-project setup.py build_ext --inplace | ||
| uv run --no-project test.py | ||
|
|
||
| - name: Build CPP only | ||
| if: inputs.build-type == 'debug' | ||
| shell: bash | ||
| run: | | ||
| mkdir -p build | ||
| cd build | ||
| cmake .. | ||
| make -j $(sysctl -n hw.ncpu) | ||
|
|
||
| - name: Run CPP tests | ||
| if: ${{ inputs.build-type == 'debug' && inputs.run-tests == 'true' }} | ||
| shell: bash | ||
| env: | ||
| DEVICE: gpu | ||
| METAL_DEVICE_WRAPPER_TYPE: 1 | ||
| METAL_DEBUG_ERROR_MODE: 0 | ||
| run: ./build/tests/tests | ||
|
|
||
| - name: Build small binary with JIT | ||
| if: inputs.build-jit == 'true' | ||
| shell: bash | ||
| run: | | ||
| mkdir -p build | ||
| cd build | ||
| cmake .. -DCMAKE_BUILD_TYPE=MinSizeRel \ | ||
| -DBUILD_SHARED_LIBS=ON \ | ||
| -DMLX_BUILD_CPU=OFF \ | ||
| -DMLX_BUILD_SAFETENSORS=OFF \ | ||
| -DMLX_BUILD_GGUF=OFF \ | ||
| -DMLX_METAL_JIT=ON | ||
| make -j $(sysctl -n hw.ncpu) | ||
|
|
||
| - name: Run Python tests with JIT | ||
| if: ${{ inputs.build-jit == 'true' && inputs.run-tests == 'true' }} | ||
| shell: bash | ||
| env: | ||
| LOW_MEMORY: 1 | ||
| DEVICE: gpu | ||
| METAL_DEVICE_WRAPPER_TYPE: 1 | ||
| METAL_DEBUG_ERROR_MODE: 0 | ||
| run: | | ||
| CMAKE_ARGS="-DMLX_METAL_JIT=ON" \ | ||
| uv pip install -e . -v | ||
| uv run -m xmlrunner discover \ | ||
| -v python/tests \ | ||
| -o test-results/gpu_jit | ||
|
|
||
| - name: Build macOS 13 package | ||
| if: inputs.build-type == 'release' | ||
| uses: ./.github/actions/build-macos-release | ||
| with: | ||
| macos-target: 13.0 | ||
| - name: Build macOS 14 package | ||
| if: inputs.build-type == 'release' | ||
| uses: ./.github/actions/build-macos-release | ||
| with: | ||
| macos-target: 14.0 | ||
| - name: Build macOS 15 package | ||
| if: inputs.build-type == 'release' | ||
| uses: ./.github/actions/build-macos-release | ||
| with: | ||
| macos-target: 15.0 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can't embed a matrix inside of a job so manually specify the combinations in series. It's not that many so it's probably ok to maintain this for now.