Document MLX JIT build patch in README - #48
Merged
Conversation
Note the MetalPerformancePrimitives SDK gap on older Xcodes (e.g. GitHub's macos-14 runner) and point to the upstream fix at ml-explore/mlx#3426 so the patches/ directory can be retired once the submodule is bumped past it.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Add a paragraph to the MLX JIT (optional) section explaining why `patches/mlx-jit-nax-gate.patch` exists: MLX's JIT branch preprocesses NAX kernel headers that `#include <MetalPerformancePrimitives/...>`, which is only in the macOS 26.2+ SDK. GitHub's `macos-14` runner (Xcode 15.x) doesn't have it, so without the patch `EMILY_MLX_JIT=1` can't configure in CI.
Links to upstream ml-explore/mlx#3426 so whoever bumps the submodule after it merges knows they can delete `patches/` and the `maybe_apply_mlx_patches` plumbing.
Test plan