Skip to main content

Convert StableHLO models into Apple Core ML format

Project description

Convert StableHLO models into Apple Core ML format

This repo is currently experimental!

Only a subset of the StableHLO operations have been implemented, and some of them may have restrictions.

Due to the current dot_general op implementation, it is only possible to target iOS >= 18.

Look in the tests directory, to see what has currently been tested.

The package is published to PyPi as stablehlo-coreml-experimental.

Converting a model

To convert a StableHLO module, do the following:

import coremltools as ct
from stablehlo_coreml.converter import convert
from stablehlo_coreml import DEFAULT_HLO_PIPELINE

mil_program = convert(hlo_module, minimum_deployment_target=ct.target.iOS18)
cml_model = ct.convert(
    mil_program,
    source="milinternal",
    minimum_deployment_target=ct.target.iOS18,
    pass_pipeline=DEFAULT_HLO_PIPELINE,
)

For a Jax project, the hlo_module can be obtained the following way:

import jax
from jax._src.lib.mlir import ir
from jax._src.interpreters import mlir as jax_mlir
from jax.export import export

import jax.numpy as jnp

def jax_function(a, b):
    return jnp.einsum("ij,jk -> ik", a, b)

context = jax_mlir.make_ir_context()
input_shapes = (jnp.zeros((2, 4)), jnp.zeros((4, 3)))
jax_exported = export(jax.jit(jax_function))(*input_shapes)
hlo_module = ir.Module.parse(jax_exported.mlir_module(), context=context)

For the Jax example to work, you will additionally need to install absl-py and flatbuffers as dependencies.

For additional examples see the tests directory.

Notes

  • coremltools supports up to python 3.13. Do not run hatch with a newer version. Can be controlled using fx export HATCH_PYTHON=python3.13
  • Run tests using hatch run test:pytest tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stablehlo_coreml_experimental-0.0.15.tar.gz (44.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stablehlo_coreml_experimental-0.0.15-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file stablehlo_coreml_experimental-0.0.15.tar.gz.

File metadata

File hashes

Hashes for stablehlo_coreml_experimental-0.0.15.tar.gz
Algorithm Hash digest
SHA256 03e6780ffe39b7477b71914311b3b4a86986eac630f62564bed5f58215ec3444
MD5 66d5472b63cb85c8d2c20dcc3add5716
BLAKE2b-256 42caf85756a226a978b2cc2cca2a925ac1f3dfc4bdfbddc150adcd674b8460e7

See more details on using hashes here.

File details

Details for the file stablehlo_coreml_experimental-0.0.15-py3-none-any.whl.

File metadata

File hashes

Hashes for stablehlo_coreml_experimental-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 944f6e9c86bb1ca6edbfbbe60ef5c5ea9125c0f0eb57fd0c47726ab16a9fc33f
MD5 d4dff820c955bc0691d7a9c3a9966f8b
BLAKE2b-256 c85ca28656de82ad8d486d7a6a86f9b28db74cf375791d830375bf03250b1abc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page