Skip to content

Add the MLX backend to the mv3 Apple demo #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shoumikhin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add the MLX backend to the mv3 Apple demo #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/export-models.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ jobs:
output: |
mv3/python/mv3.pte
mv3/python/mv3_coreml_all.pte
mv3/python/mv3_mlx.pte
mv3/python/mv3_xnnpack_fp32.pte

name: Export ${{ matrix.name }}
Expand Down
2 changes: 1 addition & 1 deletion llm/apple/etLLM.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,7 @@
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/pytorch/executorch";
requirement = {
branch = "swiftpm-1.1.0";
branch = "swiftpm-1.5.0.20260827";
kind = branch;
};
};
Expand Down
24 changes: 23 additions & 1 deletion mv3/apple/ExecuTorchDemo/ExecuTorchDemo.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@
032C02032AC47CFB002955E1 /* mv3_xnnpack_fp32.pte in Resources */ = {isa = PBXBuildFile; fileRef = 032C01FC2AC47CFB002955E1 /* mv3_xnnpack_fp32.pte */; };
032C02082AC47CFB002955E1 /* imagenet_classes.txt in Resources */ = {isa = PBXBuildFile; fileRef = 032C02012AC47CFB002955E1 /* imagenet_classes.txt */; };
03672A662DE1226100147123 /* backend_coreml in Frameworks */ = {isa = PBXBuildFile; productRef = 03672A652DE1226100147123 /* backend_coreml */; };
CAFE00010000000000000000 /* backend_mlx in Frameworks */ = {isa = PBXBuildFile; productRef = CAFE00010000000000000002 /* backend_mlx */; };
03672A6A2DE1226100147123 /* backend_xnnpack in Frameworks */ = {isa = PBXBuildFile; productRef = 03672A692DE1226100147123 /* backend_xnnpack */; };
03672A752DE144CF00147123 /* executorch_debug in Frameworks */ = {isa = PBXBuildFile; productRef = 03672A742DE144CF00147123 /* executorch_debug */; };
03672A772DE1457900147123 /* backend_coreml in Frameworks */ = {isa = PBXBuildFile; productRef = 03672A762DE1457900147123 /* backend_coreml */; };
CAFE00010000000000000001 /* backend_mlx in Frameworks */ = {isa = PBXBuildFile; productRef = CAFE00010000000000000003 /* backend_mlx */; };
03672A7B2DE1457900147123 /* backend_xnnpack in Frameworks */ = {isa = PBXBuildFile; productRef = 03672A7A2DE1457900147123 /* backend_xnnpack */; };
036834D52ACB710D00BA100F /* mv3.pte in Resources */ = {isa = PBXBuildFile; fileRef = 036834D42ACB710D00BA100F /* mv3.pte */; };
036834D62ACB710D00BA100F /* mv3.pte in Resources */ = {isa = PBXBuildFile; fileRef = 036834D42ACB710D00BA100F /* mv3.pte */; };
036834D82ACB893700BA100F /* mv3_coreml_all.pte in Resources */ = {isa = PBXBuildFile; fileRef = 036834D72ACB893700BA100F /* mv3_coreml_all.pte */; };
CAFE00010000000000000004 /* mv3_mlx.pte in Resources */ = {isa = PBXBuildFile; fileRef = CAFE00010000000000000006 /* mv3_mlx.pte */; };
03B184962E1FA1E400246294 /* kernels_optimized in Frameworks */ = {isa = PBXBuildFile; productRef = 03B184952E1FA1E400246294 /* kernels_optimized */; };
03B184982E1FA1F400246294 /* kernels_optimized in Frameworks */ = {isa = PBXBuildFile; productRef = 03B184972E1FA1F400246294 /* kernels_optimized */; };
03C818192AC671980084CC29 /* Samoyed.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 03C818182AC671980084CC29 /* Samoyed.jpg */; };
Expand All @@ -37,6 +40,7 @@
03C818482AC7BF470084CC29 /* imagenet_classes.txt in Resources */ = {isa = PBXBuildFile; fileRef = 032C02012AC47CFB002955E1 /* imagenet_classes.txt */; };
03C8184A2AC7BF470084CC29 /* mv3_xnnpack_fp32.pte in Resources */ = {isa = PBXBuildFile; fileRef = 032C01FC2AC47CFB002955E1 /* mv3_xnnpack_fp32.pte */; };
03C8DC7C2AE2533C0064384A /* mv3_coreml_all.pte in Resources */ = {isa = PBXBuildFile; fileRef = 036834D72ACB893700BA100F /* mv3_coreml_all.pte */; };
CAFE00010000000000000005 /* mv3_mlx.pte in Resources */ = {isa = PBXBuildFile; fileRef = CAFE00010000000000000006 /* mv3_mlx.pte */; };
/* End PBXBuildFile section */

/* Begin PBXContainerItemProxy section */
Expand Down Expand Up @@ -96,6 +100,7 @@
032C02012AC47CFB002955E1 /* imagenet_classes.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = imagenet_classes.txt; sourceTree = "<group>"; };
036834D42ACB710D00BA100F /* mv3.pte */ = {isa = PBXFileReference; lastKnownFileType = file; path = mv3.pte; sourceTree = "<group>"; };
036834D72ACB893700BA100F /* mv3_coreml_all.pte */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = mv3_coreml_all.pte; sourceTree = "<group>"; };
CAFE00010000000000000006 /* mv3_mlx.pte */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = mv3_mlx.pte; sourceTree = "<group>"; };
03C8180A2AC66FC30084CC29 /* MobileNetClassifierTest.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MobileNetClassifierTest.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
03C818182AC671980084CC29 /* Samoyed.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = Samoyed.jpg; sourceTree = "<group>"; };
03C8181C2AC69C280084CC29 /* Arctic fox.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = "Arctic fox.jpg"; sourceTree = "<group>"; };
Expand All @@ -116,6 +121,7 @@
03672A6A2DE1226100147123 /* backend_xnnpack in Frameworks */,
03B184962E1FA1E400246294 /* kernels_optimized in Frameworks */,
03672A662DE1226100147123 /* backend_coreml in Frameworks */,
CAFE00010000000000000000 /* backend_mlx in Frameworks */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand All @@ -136,6 +142,7 @@
03672A7B2DE1457900147123 /* backend_xnnpack in Frameworks */,
03B184982E1FA1F400246294 /* kernels_optimized in Frameworks */,
03672A772DE1457900147123 /* backend_coreml in Frameworks */,
CAFE00010000000000000001 /* backend_mlx in Frameworks */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -232,6 +239,7 @@
children = (
032C02012AC47CFB002955E1 /* imagenet_classes.txt */,
036834D72ACB893700BA100F /* mv3_coreml_all.pte */,
CAFE00010000000000000006 /* mv3_mlx.pte */,
032C01FC2AC47CFB002955E1 /* mv3_xnnpack_fp32.pte */,
036834D42ACB710D00BA100F /* mv3.pte */,
);
Expand Down Expand Up @@ -290,6 +298,7 @@
name = App;
packageProductDependencies = (
03672A652DE1226100147123 /* backend_coreml */,
CAFE00010000000000000002 /* backend_mlx */,
03672A692DE1226100147123 /* backend_xnnpack */,
03B184952E1FA1E400246294 /* kernels_optimized */,
);
Expand Down Expand Up @@ -334,6 +343,7 @@
name = MobileNetClassifierTest;
packageProductDependencies = (
03672A762DE1457900147123 /* backend_coreml */,
CAFE00010000000000000003 /* backend_mlx */,
03672A7A2DE1457900147123 /* backend_xnnpack */,
03B184972E1FA1F400246294 /* kernels_optimized */,
);
Expand Down Expand Up @@ -411,6 +421,7 @@
buildActionMask = 2147483647;
files = (
036834D82ACB893700BA100F /* mv3_coreml_all.pte in Resources */,
CAFE00010000000000000004 /* mv3_mlx.pte in Resources */,
036834D52ACB710D00BA100F /* mv3.pte in Resources */,
032C02082AC47CFB002955E1 /* imagenet_classes.txt in Resources */,
032C02032AC47CFB002955E1 /* mv3_xnnpack_fp32.pte in Resources */,
Expand All @@ -428,6 +439,7 @@
03C818192AC671980084CC29 /* Samoyed.jpg in Resources */,
03C8181F2AC69DFF0084CC29 /* hot pot.jpg in Resources */,
03C8DC7C2AE2533C0064384A /* mv3_coreml_all.pte in Resources */,
CAFE00010000000000000005 /* mv3_mlx.pte in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -786,7 +798,7 @@
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/pytorch/executorch";
requirement = {
branch = "swiftpm-1.1.0";
branch = "swiftpm-1.5.0.20260827";
kind = branch;
};
};
Expand All @@ -798,6 +810,11 @@
package = 03672A642DE1226100147123 /* XCRemoteSwiftPackageReference "executorch" */;
productName = backend_coreml;
};
CAFE00010000000000000002 /* backend_mlx */ = {
isa = XCSwiftPackageProductDependency;
package = 03672A642DE1226100147123 /* XCRemoteSwiftPackageReference "executorch" */;
productName = backend_mlx;
};
03672A692DE1226100147123 /* backend_xnnpack */ = {
isa = XCSwiftPackageProductDependency;
package = 03672A642DE1226100147123 /* XCRemoteSwiftPackageReference "executorch" */;
Expand All @@ -813,6 +830,11 @@
package = 03672A642DE1226100147123 /* XCRemoteSwiftPackageReference "executorch" */;
productName = backend_coreml;
};
CAFE00010000000000000003 /* backend_mlx */ = {
isa = XCSwiftPackageProductDependency;
package = 03672A642DE1226100147123 /* XCRemoteSwiftPackageReference "executorch" */;
productName = backend_mlx;
};
03672A7A2DE1457900147123 /* backend_xnnpack */ = {
isa = XCSwiftPackageProductDependency;
package = 03672A642DE1226100147123 /* XCRemoteSwiftPackageReference "executorch" */;
Expand Down
3 changes: 3 additions & 0 deletions mv3/apple/ExecuTorchDemo/ExecuTorchDemo/Sources/App/ClassificationController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import SwiftUI
enum Mode: String, CaseIterable {
case xnnpack = "XNNPACK"
case coreML = "Core ML"
case mlx = "MLX"
}

class ClassificationController: ObservableObject {
Expand Down Expand Up @@ -62,6 +63,8 @@ class ClassificationController: ObservableObject {
switch mode {
case .coreML:
modelFileName = "mv3_coreml_all"
case .mlx:
modelFileName = "mv3_mlx"
case .xnnpack:
modelFileName = "mv3_xnnpack_fp32"
}
Expand Down
8 changes: 8 additions & 0 deletions mv3/python/export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import torch
import torchvision.models as models
from executorch.backends.apple.coreml.partition import CoreMLPartitioner
from executorch.backends.mlx import MLXPartitioner
from executorch.exir import to_edge
from executorch.backends.xnnpack.partition.xnnpack_partitioner import XnnpackPartitioner
from executorch.exir import EdgeCompileConfig, to_edge_transform_and_lower
Expand All @@ -27,6 +28,11 @@ def main() -> None:
compile_config=EdgeCompileConfig(_skip_dim_order=True),
).to_executorch()

et_program_mlx = to_edge_transform_and_lower(
torch.export.export(model, sample_inputs),
partitioner=[MLXPartitioner()],
).to_executorch()

et_program_xnnpack = to_edge_transform_and_lower(
torch.export.export(model, sample_inputs),
partitioner=[XnnpackPartitioner()],
Expand All @@ -36,6 +42,8 @@ def main() -> None:
et_program_portable.write_to_file(file)
with open("mv3_coreml_all.pte", "wb") as file:
et_program_coreml.write_to_file(file)
with open("mv3_mlx.pte", "wb") as file:
et_program_mlx.write_to_file(file)
with open("mv3_xnnpack_fp32.pte", "wb") as file:
et_program_xnnpack.write_to_file(file)

Expand Down
Loading