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.13.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

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

File details

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

File metadata

File hashes

Hashes for stablehlo_coreml_experimental-0.0.13.tar.gz
Algorithm Hash digest
SHA256 edbe043a1b02f8c319471f1cd96e92f8033fc9191d45b2cfe7e731e348ca5e5d
MD5 6160b38a299cdf46262f9fe7e9d34855
BLAKE2b-256 53dc956a01f907e547e2716c447d952a136e214fe9ca3262405c66adca55a60a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stablehlo_coreml_experimental-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 3551e37460410dcd83ffae1aa226017f71c4fb4084dcd1974e8dad056f07f44a
MD5 9d1c79959f0119cfcfb913534178018d
BLAKE2b-256 25c416918153bbab1d87ef52960cd4bd189bc9c8455762ae801c2f44b39dae6e

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