Skip to content

Ship the MLX metallib bundle in the template #22244

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 2 commits into
base: swiftpm-macos14
Choose a base branch
from
+7 −14
Open

Ship the MLX metallib bundle in the template #22244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c7cf3a
Ship the MLX metallib bundle unconditionally in the template
shoumikhin Aug 27, 2026
06f6e38
Trim the MLX resource-bundle comment to match the main manifest
pytorchbot Aug 27, 2026
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
21 changes: 7 additions & 14 deletions Package.swift.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
*/

import PackageDescription
import Foundation

let version = "__VERSION__"
let url = "https://ossci-ios.s3.amazonaws.com/executorch/"
Expand Down Expand Up @@ -144,23 +143,17 @@ for (key, value) in products {
packageTargets.append(target)
}

// The MLX Metal kernel libraries, one per platform slice, shipped as a single
// resource bundle both MLX products share. Kept out of the generic loop above so
// there is one bundle (executorch_backend_mlx_resources.bundle) rather than a
// separate debug copy, and so the release and debug delegates resolve the same
// name. Each slice's MLX binary asks for its own mlx-<slice>.metallib. The files
// are committed to this branch by the release job and gitignored elsewhere, so
// each is included only when present.
// One resource bundle shared by both MLX products (release and debug) so they
// resolve the same bundle name, with a per-slice metallib since one slice's does
// not load on another. Kept out of the loop above to avoid a per-debug copy. The
// release job commits all three files beside the manifest, so copy them
// unconditionally.
let mlxMetallibSlices = ["mlx-ios", "mlx-ios-simulator", "mlx-macos"]
let mlxResourcesDir = ".Package.swift/backend_mlx_resources"
if products.keys.contains("backend_mlx") {
packageTargets.append(.target(
name: "backend_mlx_resources",
path: mlxResourcesDir,
resources: mlxMetallibSlices.compactMap { slice in
FileManager.default.fileExists(atPath: "\(mlxResourcesDir)/\(slice).metallib")
? .copy("\(slice).metallib") : nil
}
path: ".Package.swift/backend_mlx_resources",
resources: mlxMetallibSlices.map { .copy("\($0).metallib") }
))
for suffix in ["", debug_suffix] {
if let index = packageTargets.firstIndex(where: {
Expand Down
Loading