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

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)

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.11. Do not run hatch with a newer version. Can be controlled using fx export HATCH_PYTHON=python3.11
  • 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.3.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for stablehlo_coreml_experimental-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ded31202d331fc0dabe565ea960e780de7f5064776921b71fd1c399938a7c3a1
MD5 5534cf4d0524bc1e7e6483c7eec48a6e
BLAKE2b-256 4d48614194ed115ec2484c6314e6386792838633bcde33123d49b084a9624164

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stablehlo_coreml_experimental-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 569c69d73e4821aa78cfa63356077f05619452306884af823cf443a21068df50
MD5 540696c5a28c93d15f04d9ed1b66da65
BLAKE2b-256 38b7d736ec790e05d85a17baf1e60cb26f4676c00320802d3ca973e5eadef981

See more details on using hashes here.

Supported by

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