coreml_to_ane_hwx

KO | EN

gitlite — search

#typescript #llm #golang #android #machine-learning #rust #java #windows #awesome #cli #pytorch #ios #mcp #openai

coreml_to_ane_hwx

(★ 40)

a quick and dirty little program to convert Apple CoreML model to ANE hwx file

coreml_to_ane_hwx Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# coreml_to_ane_hwx
a quick and dirty little program to convert Apple CoreML model to ANE hwx file

# CoreML model
CoreML format is publicly available, https://apple.github.io/coremltools/mlmodel/index.html

# HWX
HWX is a proprietary modified Mach-O file format to pass models to AppleH11ANEInterface, an I/O Kit kernel driver in macOS and iOS when Apple Neural Engine is available.

# How to use this little program

## Quick Start

Simply `make` it on macOS either x86_64 or Apple Silicon machines. YES, Apple ships ANE related x86_64 binaries on machines without ANE, so we can compile and run this on x86_64 machines.

Get a CoreML model, e.g., `wget https://ml-assets.apple.com/coreml/models/Image/ImageClassification/MobileNetV2/MobileNetV2.mlmodel` or use [coremltools](https://github.com/apple/coremltools) to convert one. Then, we can convert the model by
```
./coreml2hwx MobileNetV2.mlmodel debug
```
And get results like

```
./coreml2hwx MobileNetV2.mlmodel debug
2021-05-24 18:47:38.549 coreml2hwx[44933:4104983] original mlmodel file: file:///Users/freedom/work/coreml_to_ane_hwx/MobileNetV2.mlmodel 
2021-05-24 18:47:39.175 coreml2hwx[44933:4104983] espresso model in mlmodelc directory: /var/folders/w5/979yc47d3xd7217w52w_59tm0000gn/T/MobileNetV2_BBAC2D27-E28E-4135-ABB4-E5B8C81C395B.mlmodelc/model.espresso.net 
2021-05-24 18:47:40.064 coreml2hwx[44933:4104983] options:
{
    InputNetworks =     (
                {
            NetworkPlistName = "net.plist";
            NetworkPlistPath = "/tmp/espresso_ir_dump/";
        }
    );
    OutputFileName = "model.hwx";
    OutputFilePath = "/tmp/hwx_output/MobileNetV2/";
}
2021-05-24 18:47:40.064 coreml2hwx[44933:4104983] result at /tmp/hwx_output/MobileNetV2/model.hwx
2021-05-24 18:47:40.064 coreml2hwx[44933:4104983] other debug information at /tmp/hwx_output/MobileNetV2/
```

## Detailed Workflow Guide

For a complete end-to-end guide on generating `.hwx` files from PyTorch/TensorFlow models, see:

📖 **[WORKFLOW_MLPACKAGE_TO_HWX_ANALYSIS.md](WORKFLOW_MLPACKAGE_TO_HWX_ANALYSIS.md)** - Complete compilation pipeline walkthrough

This guide covers:
- Converting PyTorch/TensorFlow models to CoreML (`.mlpackage`)
- Compiling `.mlpackage` to `.mlmodelc` (compiled model)
- Extracting MIL (Model Intermediate Language) representation
- Generating `.hwx` files for different ANE architectures (H14-H18)
- Parsing and analyzing the generated `.hwx` files
- Troubleshooting common issues

# mlmodelc to hwx
There are many compiled CoreML models in macOS and iOS. Some have meta infomation; some do not. For those
who do not have meta information, we still can dump information with ANECCompile/Zin compiler.

```
./mlmodelc2hwx /System/Library/PrivateFrameworks/CoreHandwriting.framework/Versions/A/Resources/zh.bundle debug
2021-06-14 15:00:23.145 mlmodelc2hwx[36034:2122508] espresso model in mlmodelc directory: /System/Library/PrivateFrameworks/CoreHandwriting.framework/Versions/A/Resources/zh.bundle/model.espresso.net 
2021-06-14 15:00:24.063 mlmodelc2hwx[36034:2122508] options:
{
    InputNetworks =     (
                {
            NetworkPlistName = "net.plist";
            NetworkPlistPath = "/tmp/espresso_ir_dump/";
        }
    );
    OutputFileName = "model.hwx";
    OutputFilePath = "/tmp/hwx_output/zh/";
}
2021-06-14 15:00:24.063 mlmodelc2hwx[36034:2122508] result at /tmp/hwx_output/zh/model.hwx
2021-06-14 15:00:24.063 mlmodelc2hwx[36034:2122508] other debug information at /tmp/hwx_output/zh/
```
In the DOT graph files in /tmp/hwx_output/zh/, we can see easily see the Chinese handwritten recongition CNN model takes a 48x48 bitmap and outputs a 29,321 array.

# Credits
@geohot reverse-engineered lots ANE related information, including HWX format. See [ane code](https://github.com/tinygrad/tinygrad/tree/v0.10.3/extra/accel/ane) in tinygrad and his hacking videos.

@geekwish provided useful Espresso related information in his [ANETools](https://github.com/antgroup-arclab/ANETools).

---

## 🌐 Web-Based HWX Analyzer

Try the **interactive web-based parser** (no installation needed):

👉 **[https://freedomtan.github.io/coreml_to_ane_hwx/hwx_dump_js/](https://freedomtan.github.io/coreml_to_ane_hwx/hwx_dump_js/)**

Features:
- Drag & drop `.hwx` files directly in your browser
- Client-side parsing (no files uploaded to servers)
- Visual register inspector for all hardware blocks
- Supports H13-H18 architectures (A14-A19 chips)
- Generated by Antigravity CLI from the [ANE HWX Format Guide](GUIDE_ANE_HWX_FORMAT.md)

coreml_to_ane_hwx

coreml_to_ane_hwx Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

coreml_to_ane_hwx

coreml_to_ane_hwx Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README