Skip to content

Commit d1175cf

Browse files
authored
Update README-wheel.md to document what's linked into pybindings (#3323)
* Stop linking MPS into the prebuilt pip wheel We haven't tested this, and we'd prefer to have both MPS and Core ML working. Remove it for now, putting macOS and Linux on equal footing. * Update README-wheel.md to document what's linked into pybindings Since pybindings can be built with many configurations, it's important to tell users what's actually present in the wheel.
1 parent ed1992c commit d1175cf

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README-wheel.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@ standard on-device iOS and Android mobile deployments. One of the main goals for
44
ExecuTorch is to enable wider customization and deployment capabilities of the
55
PyTorch programs.
66

7+
The `executorch` pip package is in alpha.
8+
* Required python version: `==3.10`
9+
* Compatible systems: Linux x86_64, macOS aarch64
10+
11+
The prebuilt `executorch.extension.pybindings.portable_lib` module included in
12+
this package provides a way to run ExecuTorch `.pte` files, with some
13+
restrictions:
14+
* Only [core ATen
15+
operators](https://pytorch.org/executorch/stable/ir-ops-set-definition.html)
16+
are linked into the prebuilt module
17+
* Only the [XNNPACK backend
18+
delegate](https://pytorch.org/executorch/main/native-delegates-executorch-xnnpack-delegate.html)
19+
is linked into the prebuilt module
20+
721
Please visit the [ExecuTorch website](https://pytorch.org/executorch/) for
822
tutorials and documentation. Here are some starting points:
923
* [Getting

build/packaging/env_var_script_m1.sh

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
2121

2222
# When building for macOS, link additional backends into the pybindings runtime.
2323

24-
# TODO(dbort): Core ML requires features only available in macOS 10.15, but the
24+
# TODO(dbort): Make these build properly in the CI environment.
2525
# build machine uses an older version.
2626
# CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
27-
28-
CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
27+
# CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"

0 commit comments

Comments
 (0)