Start here

iree-metal reference

Source-linked documentation for the Metal compiler target, runtime HAL driver, and PJRT integration.

This site documents the source surfaces that connect JAX programs to Apple's Metal GPU stack in iree-metal. Every available definition links to the exact source revision.

The reference is pinned to commit 35a8adb. That makes signatures and source locations stable even as the development branch moves.

What is covered

  • compiler/plugins/target/MetalSPIRV: the compiler path that converts SPIR-V to Metal Shading Language and packages Metal libraries.
  • runtime/src/iree/hal/drivers/metal: the Metal HAL driver's public and internal C/Objective-C interfaces.
  • integrations/pjrt/src/iree_pjrt: the PJRT bridge used to expose IREE-backed devices and compilation to JAX.

The API pages are extracted from the repository rather than copied by hand. Use the source links beside declarations when you need implementation context.

Scope

This is reference material for the experimental fork, not the canonical IREE documentation. For the project overview, supported workflows, and installation notes, start with the iree-metal README.