Enable CoreML by default on macOS wheel builds #9483

jathu · 2025-03-21T02:49:03Z

Summary

Context: #9481

Include the executorchcoreml pybinding in the builds
Remove separate installation option
Turn on CoreML by default for macOS builds
Add a dependency on coremltools for macOS

Test plan

CI

$ rm -rf cmake-out pip-out dist && ./install_executorch.sh
$ ./examples/models/llama/install_requirements.sh
$ .ci/scripts/test_llama.sh -model stories110M -build_tool cmake -dtype fp32 -mode coreml
$ .ci/scripts/test_llama.sh -model stories110M -build_tool cmake -dtype fp32 -mode xnnpack+custom+quantize_kv

cc @larryliu0820 @lucylq

pytorch-bot · 2025-03-21T02:49:07Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9483

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 2 New Failures, 1 Pending

As of commit 6488b44 with merge base 265b9b7 ():

NEW FAILURES - The following jobs have failed:

trunk / test-arm-backend-delegation / linux-job (gh)
RuntimeError: Command docker exec -t a163b9ffe417b5c07bb25e13c9071ae6c161ead5abbee6a108f5d7953d6e0f12 /exec failed with exit code 1
trunk / test-arm-reference-delegation / linux-job (gh)
backends/arm/test/ops/test_bmm.py::TestBMM::test_bmm_single_input_tosa_MI_2

This comment was automatically generated by Dr. CI and updates every 15 minutes.

jathu · 2025-03-26T15:07:51Z

I will update the docs on usage of the install script in another PR.

mergennachin · 2025-03-26T15:42:19Z

This is awesome!

cc @YifanShenSZ @cymbalrush

mergennachin · 2025-03-26T15:44:32Z

pyproject.toml

  "tabulate",
  "typing-extensions",
+  # Keep this version in sync with: ./backends/apple/coreml/scripts/install_requirements.sh
+  "coremltools==8.1; platform_system == 'Darwin'",


mergennachin · 2025-03-26T15:51:00Z

backends/apple/coreml/scripts/install_requirements.sh

-    echo "${red}ExecuTorch: Failed to install coremltools."
-    exit 1
-fi
+cmake --build "$COREMLTOOLS_DIR_PATH/build" --parallel --target mlmodel


@YifanShenSZ @cymbalrush -- any reason why we still need to build mlmodel target from source, instead of using directly from pip install coremltools?

It shouldn't be required any more but let me confirm

@jathu

Okay, let's not block it, but create an GH issue to track this...

cymbalrush

Thank you!

### Summary * After #9483, we should have CoreML support out of the box for macOS * Unfortunately, we still need `backends/apple/coreml/scripts/install_requirements.sh` to use the [coreml_executorch_runner](https://github.com/pytorch/executorch/tree/main/examples/apple/coreml/executor_runner) (used for testing) * I should have caught all the usage ### Test plan Read

@larryliu0820

### Summary Context: #9481 * Include the `executorchcoreml` pybinding in the builds * Remove separate installation option * Turn on CoreML by default for macOS builds * Add a dependency on coremltools for macOS ### Test plan CI ``` $ rm -rf cmake-out pip-out dist && ./install_executorch.sh $ ./examples/models/llama/install_requirements.sh $ .ci/scripts/test_llama.sh -model stories110M -build_tool cmake -dtype fp32 -mode coreml $ .ci/scripts/test_llama.sh -model stories110M -build_tool cmake -dtype fp32 -mode xnnpack+custom+quantize_kv ``` cc @larryliu0820 @lucylq

### Summary * After #9483, we should have CoreML support out of the box for macOS * Unfortunately, we still need `backends/apple/coreml/scripts/install_requirements.sh` to use the [coreml_executorch_runner](https://github.com/pytorch/executorch/tree/main/examples/apple/coreml/executor_runner) (used for testing) * I should have caught all the usage ### Test plan Read

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Mar 21, 2025

jathu force-pushed the jathu/include-inmemoryfs branch from b69b9de to 40f1586 Compare March 21, 2025 02:49

jathu added module: build/install Issues related to the cmake and buck2 builds, and to installing ExecuTorch ciflow/trunk topic: not user facing labels Mar 21, 2025

jathu force-pushed the jathu/include-inmemoryfs branch 5 times, most recently from 899aaa9 to 4e1392f Compare March 21, 2025 03:40

jathu force-pushed the jathu/inmemoryfs-binding branch from a2189cd to 8401ea6 Compare March 21, 2025 03:42

jathu force-pushed the jathu/include-inmemoryfs branch 2 times, most recently from 4ca7508 to 1ec9fe8 Compare March 21, 2025 03:47

jathu force-pushed the jathu/inmemoryfs-binding branch from 8401ea6 to 3d18509 Compare March 21, 2025 03:51

jathu force-pushed the jathu/include-inmemoryfs branch from 1ec9fe8 to c953ad3 Compare March 21, 2025 03:52

jathu changed the title ~~Use inmemoryfs built with CMake instead of extra wheel~~ Use executorchcoreml built with CMake instead of extra wheel Mar 21, 2025

jathu force-pushed the jathu/inmemoryfs-binding branch 3 times, most recently from eaddcd2 to dc338bd Compare March 21, 2025 14:57

jathu force-pushed the jathu/include-inmemoryfs branch 2 times, most recently from c5b2718 to a43c12c Compare March 21, 2025 15:19

jathu force-pushed the jathu/inmemoryfs-binding branch 2 times, most recently from 5bc0bdc to 7e51d3a Compare March 25, 2025 00:11

jathu force-pushed the jathu/include-inmemoryfs branch 2 times, most recently from 962c878 to ab60961 Compare March 25, 2025 00:24

jathu force-pushed the jathu/inmemoryfs-binding branch 2 times, most recently from 1287a85 to 2f299ac Compare March 25, 2025 01:52

jathu force-pushed the jathu/include-inmemoryfs branch 2 times, most recently from 52ce71d to e7adb4c Compare March 25, 2025 15:01

jathu force-pushed the jathu/include-inmemoryfs branch 2 times, most recently from 9f1119a to 840151e Compare March 26, 2025 03:40

jathu added 6 commits March 26, 2025 08:05

address comments

9665d9f

address comments

b1d24e1

split targets

bc0d603

address comments

822eb7a

build inmemoryfs when coreml or pybindings enabled

c45b196

update usage

1f235f5

jathu force-pushed the jathu/include-inmemoryfs branch from ce38301 to 6c747a7 Compare March 26, 2025 15:05

jathu marked this pull request as ready for review March 26, 2025 15:07

jathu requested review from cccclai, metascroy and shoumikhin as code owners March 26, 2025 15:07

clean up coreml install_requirements

6488b44

jathu force-pushed the jathu/include-inmemoryfs branch from 6c747a7 to 6488b44 Compare March 26, 2025 15:31

mergennachin reviewed Mar 26, 2025

View reviewed changes

jathu mentioned this pull request Mar 26, 2025

Updates docs to reflect changes in CoreML #9645

Merged

cymbalrush approved these changes Mar 26, 2025

View reviewed changes

mergennachin approved these changes Mar 26, 2025

View reviewed changes

jathu mentioned this pull request Mar 26, 2025

Remove the requirement to install requirements for CoreML #9651

Open

jathu merged commit 46937eb into main Mar 26, 2025
169 of 172 checks passed

jathu deleted the jathu/include-inmemoryfs branch March 26, 2025 19:04

jathu mentioned this pull request Mar 28, 2025

Support exporting QNN models with Python wheels out-of-the-box #9474

Open

jathu mentioned this pull request Apr 10, 2025

"Building an ExecuTorch iOS Demo App" Feedback #10066

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enable CoreML by default on macOS wheel builds #9483

Enable CoreML by default on macOS wheel builds #9483

Uh oh!

jathu commented Mar 21, 2025 •

edited

Loading

Uh oh!

pytorch-bot bot commented Mar 21, 2025 •

edited

Loading

Uh oh!

jathu commented Mar 26, 2025

Uh oh!

mergennachin commented Mar 26, 2025

Uh oh!

mergennachin Mar 26, 2025

Uh oh!

mergennachin Mar 26, 2025

Uh oh!

cymbalrush Mar 26, 2025

Uh oh!

mergennachin Mar 26, 2025

Uh oh!

jathu Mar 26, 2025

Uh oh!

cymbalrush left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Enable CoreML by default on macOS wheel builds #9483

Enable CoreML by default on macOS wheel builds #9483

Uh oh!

Conversation

jathu commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

pytorch-bot bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9483

❌ 2 New Failures, 1 Pending

Uh oh!

jathu commented Mar 26, 2025

Uh oh!

mergennachin commented Mar 26, 2025

Uh oh!

mergennachin Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

mergennachin Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

cymbalrush Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

mergennachin Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jathu Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

cymbalrush left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jathu commented Mar 21, 2025 •

edited

Loading

pytorch-bot bot commented Mar 21, 2025 •

edited

Loading