Skip to content

Commit 875e987

Browse files
committed
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 875e987

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README-wheel.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ 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 provides a way to
12+
run ExecuTorch `.pte` files, with some restrictions:
13+
* Only [core ATen
14+
operators](https://pytorch.org/executorch/stable/ir-ops-set-definition.html)
15+
are linked into the module
16+
* Some host-CPU-compatible backends are linked into the module:
17+
* Linux: XNNPACK
18+
* macOS: XNNPACK, MPS
19+
* Core ML will be linked into the module in a future release. It is
20+
generally available for ExecuTorch users in other contexts, but is not
21+
linked into this module because of some automated build issues.
22+
723
Please visit the [ExecuTorch website](https://pytorch.org/executorch/) for
824
tutorials and documentation. Here are some starting points:
925
* [Getting

0 commit comments

Comments
 (0)