Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
onnxruntime-ep-mlx
An MLX-native execution provider for ONNX Runtime on Apple Silicon. It accelerates encoders, LLM prefill, and token-at-a-time decode as an out-of-tree plugin: no ONNX Runtime fork is required. Unsupported operators stay on ORT's CPU provider.
Install and use
Requires macOS 14+ on Apple Silicon, Python 3.11+, and ONNX Runtime 1.31 or newer. The wheel bundles the MLX runtime; source-build tools are not needed.
=
=
The Python package also exposes library_path(), ep_name(), version(), and
append_to_session_options(so). Other language bindings can load the same
libonnxruntime_mlx_ep.dylib through ORT's plugin-EP API.
ONNX Runtime compatibility
Package versions follow 0.<ORT_API_VERSION>.<patch>. The minor version identifies the
target C ABI, not the ONNX model opset.
| Package series | Minimum ONNX Runtime | Target ORT_API_VERSION |
|---|---|---|
0.31.x |
1.31 | 31 |
0.29.x (earlier releases) |
1.29 | 29 |
Version 0.31.0 targets the C ABI from
ONNX Runtime 1.31.0.
CI and release builds use 1.31 headers and runtime.
Registration rejects runtimes that cannot provide API 31.
How it works
ONNX fused subgraph → MLX graph → mlx_compile → mlx_eval → ORT outputs
The EP translates supported ONNX regions into MLX, compiles reusable closures, and leaves unsupported
ops on ORT CPU. It covers common encoder and decoder operators, including quantized matmul, GQA/MHA,
PagedAttention, RoPE, normalization, convolution, pooling, reductions, and shape operations. See
docs/OP_ARCHITECTURE.md for the coverage table.
Large, fully claimed regions are fastest. Dynamic shapes are compiled per shape key; autoregressive
decode uses a shapeless path so growing KV length does not retrace. Use
ONNXRUNTIME_EP_MLX_VERBOSE=1 or ONNXRUNTIME_EP_MLX_CLAIM_DEBUG=1 to diagnose fallback and
fragmentation.
Build from source
Source builds require a Rust toolchain, CMake 3.25+, a C++20 compiler, curl, unzip, and the
ONNX Runtime 1.31 headers. The setup script pins MLX 0.32.2 (1f8e74e3) and mlx-c (c74db530);
both are required build dependencies.
# Output: rust/target/release/libonnxruntime_mlx_ep.dylib
Alternatively, set ORT_INCLUDE_DIR directly to the 1.31 include directory. Each MLX prefix must
contain include/ and lib/; wheel builds also bundle mlx.metallib and an optional libjaccl.dylib
from MLX_PREFIX/lib.
The crate binds the ORT plugin-EP C ABI and mlx-c directly via bindgen; it does not link
libonnxruntime (ORT is reached through the OrtApi function-pointer table passed to
CreateEpFactories).
C / C++
Register the dylib with OrtApi::RegisterExecutionProviderLibrary, find its OrtEpDevice in
OrtApi::GetEpDevices, and pass that device to OrtApi::SessionOptionsAppendExecutionProvider_V2.
The device's EpDevice_EpName is MLXExecutionProvider; the V2 API takes devices, not provider-name strings.
From Rust via onnx-genai: ONNX_GENAI_EP=metal +
ONNX_GENAI_METAL_EP_LIB=/abs/path/libonnxruntime_mlx_ep.dylib.
Large-decoder partition metadata
The EP automatically infers residual layer boundaries from graph topology for decoders of about 24
layers or larger. Exporters can make the boundaries explicit with the
ONNX custom metadata key onnxruntime_ep_mlx.layer_boundary_outputs. Its value is a JSON array of
residual output tensor names, one per transformer layer:
=
=
=
=
Metadata takes precedence over inference and does not rely on node names. The EP chooses a dynamic
group size of 4-8 layers, targeting about seven partitions. Override it with
ONNXRUNTIME_EP_MLX_LAYER_PARTITIONS=<layers>; use 0 or off to disable partitioning.
Performance (M1 Max, warm)
These are previously measured results, not new ONNX Runtime 1.31 benchmarks.
Real end-to-end models, median of 10 runs, MLX EP vs the ORT CPU EP on the same machine — top-1 identical and max abs diff ≤ 6e-5 in every case:
| Model | Workload | CPU EP | MLX EP | Speedup |
|---|---|---|---|---|
| Perch v2 | audio encoder (with DFT front-end) | 64.0 ms | 12.0 ms | 5.3× |
| Perch v2 (no DFT) | audio encoder | 56.5 ms | 12.0 ms | 4.7× |
| BirdNET | audio classifier (CNN) | 14.9 ms | 7.3 ms | 2.0× |
| gemma-4-E2B | vision encoder (fp16 ViT) | 267 ms | 47 ms | 5.7× |
Feed-forward encoders (audio / CNN / vision) are the EP's sweet spot: the whole graph fuses into a
single MLX closure that is traced + mlx_compiled once and replayed, so a static-shape model runs
end-to-end on the GPU with one dispatch (e.g. Perch: 725/725 nodes claimed, 1 fused subgraph).
Supported control flow stays inside that compiled boundary. Scan bodies are shape-specialized and
unrolled at trace time (including dynamic sequence dimensions), with per-input/per-output axes and
forward/reverse directions; carried-state Loop bodies are also unrolled. Host-readable If
branches and Loop trip counts are specialized and cached per decision (capped at 16 variants per
session; additional variants run eager), so surrounding tensor ops and the selected body replay as
one MLX closure. Data-dependent conditions, early-exit loops, and loop scan outputs remain on ORT
CPU.
Eligible BF16 INT4/INT8 prefill matmuls (block size 32/64/128, at least 32 rows) explicitly use stock
MLX's FP16 compute path by default. Set ONNXRUNTIME_EP_MLX_BF16_QMM_FP16=0 to disable it.
The Foundry Local q4f16 decoders below run on the same M1 Max, warm, MLX EP vs the ORT CPU EP (decode = 1 token with 128 past; prefill = 128-token step):
| Model | Arch | Prefill | Decode |
|---|---|---|---|
| Qwen2.5-0.5B | GQA, external rotary | 5.2× | dispatch-bound (CPU-favored) |
| Phi-3.5-mini | Phi3, GQA | 5.29× | 1.19× |
| Phi-4-mini | Phi4, long-context RoPE | 5.78× | 1.10× |
| Mistral-7B-Instruct | GQA, growing KV | 11.89× | 3.30× |
| gemma-4-E2B | Gemma3n, 15-layer | 3.3× | 3.3× |
Muse-Glimmer-30B INT4, with the optimized bundled MLX runtime and automatic 8-layer groups, reaches 138.67 prefill tok/s at 512 tokens and 14.79 decode tok/s over 200 generated tokens. The same-quantization llama.cpp baseline reaches 137.84 / 13.50 tok/s.
Decode is weight-bandwidth-bound: small models can favor CPU, while larger q4 decoders benefit from MLX. Unclaimed ops fall back to ORT CPU.
Profiling & tracing (Perfetto)
The EP ships a built-in tracer (compiled in by default, near-zero cost when off). Recording is gated entirely by environment variables — set one, run your model, and inspect the result.
Get a Perfetto/Chrome trace. Point ONNXRUNTIME_EP_MLX_TRACE at an output path; the JSON trace is
written when the inference session is torn down:
ONNXRUNTIME_EP_MLX_TRACE=/tmp/mlx_trace.json
# then open https://ui.perfetto.dev (or chrome://tracing) and load /tmp/mlx_trace.json
The timeline shows one span per fused subgraph (mlx.subgraph), a nested span around the synchronous
mlx_eval (mlx.eval — its CPU wall time is the GPU-inclusive time of the whole fused subgraph),
per-op build spans with shapes/dtype/bytes, and counter tracks for GPU memory / utilisation. Ops that
fell back to a slower composed path (despite a fused kernel existing) are coloured distinctly with a
reason=…, and a top-10 slowest-ops summary is emitted at teardown.
Lighter options (no JSON file):
| Env var | Effect |
|---|---|
ONNXRUNTIME_EP_MLX_VERBOSE=1 |
Print the end-of-run session summary (claim rate, compute-path breakdown, time attribution) to stderr. |
ONNXRUNTIME_EP_MLX_CLAIM_DEBUG=1 |
Print each unclaimed node + the actionable reason (why the graph fragmented). |
ONNXRUNTIME_EP_MLX_SIGNPOST=1 |
Emit os_signpost intervals so an Instruments Metal System Trace correlates. |
ONNXRUNTIME_EP_MLX_NO_STABLE_CROSS_CACHE=1 |
Disable per-generation MLX reuse of immutable MHA cross-attention K/V inputs for performance A/B. |
Per-kernel GPU detail (Xcode). MLX hides its Metal command buffers inside one fused mlx_eval, so
the JSON trace times the fused eval as a whole. To see inside it, capture a boundary eval to a
.gputrace bundle (full per-kernel timing / occupancy / bandwidth) and open it in Xcode:
MTL_CAPTURE_ENABLED=1 \
ONNXRUNTIME_EP_MLX_GPU_CAPTURE=/tmp/mlx.gputrace \
ONNXRUNTIME_EP_MLX_GPU_CAPTURE_EVAL=5 \
MTL_CAPTURE_ENABLED=1 must be set before process start. …_GPU_CAPTURE_EVAL picks which eval to
capture (0-based, default 0); for decode, eval 0 is prefill/warmup, so pick a steady-state token.
Concurrency
MLX evaluation is thread-affine. Use one InferenceSession per thread; do not call Run() on one
shared session from multiple threads.
Numerical accuracy
Outputs are tolerance-matched against ORT CPU but are not bit-identical. Long greedy generations can diverge after near-tied logits because MLX and CPU use different floating-point reduction orders.
Layout
docs/ design docs (DESIGN, OP_ARCHITECTURE, COMPILED_CAPTURE, MLX_EVALUATION)
rust/ the Rust EP: plugin-EP C-ABI vtables (factory/ep) + the modular ONNX->MLX
translator (engine, registry, ops/*.rs) over a mlx-c RAII layer (mlx.rs)
python/ pure-Python pip package (onnxruntime-ep-mlx): a locator that bundles + registers
the cargo-built dylib (hatchling build hook, hatch_build.py)
tests/ MLX op-correctness (tests/ops, pytest) + ONNX-standard conformance (tests/conformance)
.github/ CI (cargo build + op tests) and PyPI trusted-publishing workflows
Testing
Build the EP (above), then run the pytest op-correctness suite (MLX vs ORT CPU reference):
tests/ops— each translated decoder op via MLX vs. ORT CPU reference (tolerance-gated, pytest)tests/backend— official ONNX node, simple, and PyTorch operator/converted cases. CI pins ONNX 1.23.2. Its publicBackendTestrunner obtains node models and input/expected datasets in memory viaload_model_tests(kind="node"); packaged node fixture directories and the generate-data CLI are not needed. Collection fails if any intended category is empty. Models run unchanged with their original datasets and tolerances. Explicit runtime IR/domain-opset limit rejections become version-reasoned skips. Attention-25 window attributes added in ONNX 1.23 are also skipped only when ORT rejects that exact official attribute on the matching valid model node; other invalid-graph errors fail. BF16 tensor inputs/outputs skip only when independent public ORT CPU probes demonstrate the required NumPy input/output conversion is unavailable. The probes use Shape/Constant (no casts), preserve dtype/values when supported, and are cached per process. They do not rewrite real models or suppress internal-BF16-only models, malformed graphs, or unrelated runtime failures. No models are rewritten. Kernel errors and output mismatches still fail, with CPU fallback available for ops MLX does not claim. The loader/adapter regressions can run without Metal:python -m pytest tests/backend/test_backend_adapter.py -q.tests/conformance— opt-in fuzz-conformance of the MLX EP against the ONNX standard (cbourjau/onnx-tests); seetests/conformance/README.md