Building and Running ExecuTorch on CoreML Backend¶
CoreML delegate uses CoreML apis to enable running neural networks via Apple’s hardware acceleration. For more about coreml you can read here. In this tutorial we will walk through steps of lowering a PyTorch model to CoreML delegate
In this tutorial you will learn how to export MobileNet V3 model so that it runs on CoreML backend.
You will also learn how to deploy and run the exported model on a supported Apple device.
Prerequisites (Hardware and Software)¶
In order to be able to successfully build and run the ExecuTorch’s CoreML backend you’ll need the following hardware and software components.
Hardware:¶
Setting up your developer environment¶
Make sure that you have completed the ExecuTorch setup tutorials linked to at the top of this page and setup the environment.
Run
install_requirements.shto install dependencies required by the CoreML backend.
cd executorch
sh backends/apple/coreml/scripts/install_requirements.sh
Install Xcode.
Install Xcode Command Line Tools.
xcode-select --install
Build¶
AOT (Ahead-of-time) components:¶
Exporting a CoreML delegated Program:
In this step, you will lower the MobileNet V3 model to the CoreML backend and export the ExecuTorch program. You’ll then deploy and run the exported program on a supported Apple device using CoreML backend.
cd executorch
# Generates ./mv3_coreml_all.pte file.
python3 -m examples.apple.coreml.scripts.export_and_delegate --model_name mv3
CoreML backend uses coremltools to lower Edge dialect to CoreML format and then bundles it in the
.ptefile.
Runtime:¶
Running the CoreML delegated Program:
Build the runner.
cd executorch
# Generates ./coreml_executor_runner.
sh examples/apple/coreml/scripts/build_executor_runner.sh
Run the exported program.
cd executorch
# Runs the exported mv3 model on the CoreML backend.
./coreml_executor_runner --model_path mv3_coreml_all.pte
Deploying and running on a device¶
Running the CoreML delegated Program using the Demo iOS App:
Please follow the Export Model step of the tutorial to bundle the exported MobileNet V3 program. You only need to do the CoreML part.
Complete the Build Runtime and Backends section of the tutorial. When building the frameworks you only need the
coremloption.Complete the Final Steps section of the tutorial to build and run the demo app.
Running the CoreML delegated Program using your own App
Build CoreML delegate. The following will create a
executorch.xcframeworkin thecmake-outdirectory.
cd executorch
./build/build_apple_frameworks.sh --Release --coreml
Create a new Xcode project or open an existing project.
Drag the
executorch.xcframeworkgenerated from Step 2 to Frameworks.Go to the project’s Build Phases - Link Binaries With Libraries, click the + sign, and add the following frameworks:
- executorch.xcframework
- coreml_backend.xcframework
- Accelerate.framework
- CoreML.framework
- libsqlite3.tbd
Add the exported program to the Copy Bundle Phase of your Xcode target.
Please follow the running a model tutorial to integrate the code for loading a ExecuTorch program.
Update the code to load the program from the Application’s bundle.
using namespace torch::executor;
NSURL *model_url = [NBundle.mainBundle URLForResource:@"mv3_coreml_all" extension:@"pte"];
Result<util::FileDataLoader> loader =
util::FileDataLoader::from(model_url.path.UTF8String);
Use Xcode to deploy the application on the device.
The application can now run the MobileNet V3 model on the CoreML backend.
In this tutorial, you have learned how to lower the MobileNet V3 model to the CoreML backend, deploy, and run it on an Apple device.
