Skip to content

Commit e55ce43

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 0cd80f6 commit e55ce43

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
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

0 commit comments

Comments
 (0)