xref: /aosp_15_r20/external/executorch/README-wheel.md (revision 523fa7a60841cd1ecfb9cc4201f1ca8b03ed023a)
1*523fa7a6SAndroid Build Coastguard Worker**ExecuTorch** is a [PyTorch](https://pytorch.org/) platform that provides
2*523fa7a6SAndroid Build Coastguard Workerinfrastructure to run PyTorch programs everywhere from AR/VR wearables to
3*523fa7a6SAndroid Build Coastguard Workerstandard on-device iOS and Android mobile deployments. One of the main goals for
4*523fa7a6SAndroid Build Coastguard WorkerExecuTorch is to enable wider customization and deployment capabilities of the
5*523fa7a6SAndroid Build Coastguard WorkerPyTorch programs.
6*523fa7a6SAndroid Build Coastguard Worker
7*523fa7a6SAndroid Build Coastguard WorkerThe `executorch` pip package is in alpha.
8*523fa7a6SAndroid Build Coastguard Worker* Supported python versions: 3.10, 3.11
9*523fa7a6SAndroid Build Coastguard Worker* Compatible systems: Linux x86_64, macOS aarch64
10*523fa7a6SAndroid Build Coastguard Worker
11*523fa7a6SAndroid Build Coastguard WorkerThe prebuilt `executorch.extension.pybindings.portable_lib` module included in
12*523fa7a6SAndroid Build Coastguard Workerthis package provides a way to run ExecuTorch `.pte` files, with some
13*523fa7a6SAndroid Build Coastguard Workerrestrictions:
14*523fa7a6SAndroid Build Coastguard Worker* Only [core ATen
15*523fa7a6SAndroid Build Coastguard Worker  operators](https://pytorch.org/executorch/stable/ir-ops-set-definition.html)
16*523fa7a6SAndroid Build Coastguard Worker  are linked into the prebuilt module
17*523fa7a6SAndroid Build Coastguard Worker* Only the [XNNPACK backend
18*523fa7a6SAndroid Build Coastguard Worker  delegate](https://pytorch.org/executorch/main/native-delegates-executorch-xnnpack-delegate.html)
19*523fa7a6SAndroid Build Coastguard Worker  is linked into the prebuilt module
20*523fa7a6SAndroid Build Coastguard Worker* [macOS only] [Core ML](https://pytorch.org/executorch/main/build-run-coreml.html) and [MPS](https://pytorch.org/executorch/main/build-run-mps.html) backend delegates are linked into the prebuilt module.
21*523fa7a6SAndroid Build Coastguard Worker
22*523fa7a6SAndroid Build Coastguard WorkerPlease visit the [ExecuTorch website](https://pytorch.org/executorch/) for
23*523fa7a6SAndroid Build Coastguard Workertutorials and documentation. Here are some starting points:
24*523fa7a6SAndroid Build Coastguard Worker* [Getting
25*523fa7a6SAndroid Build Coastguard Worker  Started](https://pytorch.org/executorch/stable/getting-started-setup.html)
26*523fa7a6SAndroid Build Coastguard Worker  * Set up the ExecuTorch environment and run PyTorch models locally.
27*523fa7a6SAndroid Build Coastguard Worker* [Working with
28*523fa7a6SAndroid Build Coastguard Worker  local LLMs](https://pytorch.org/executorch/stable/llm/getting-started.html)
29*523fa7a6SAndroid Build Coastguard Worker  * Learn how to use ExecuTorch to export and accelerate a large-language model
30*523fa7a6SAndroid Build Coastguard Worker    from scratch.
31*523fa7a6SAndroid Build Coastguard Worker* [Exporting to
32*523fa7a6SAndroid Build Coastguard Worker  ExecuTorch](https://pytorch.org/executorch/main/tutorials/export-to-executorch-tutorial.html)
33*523fa7a6SAndroid Build Coastguard Worker  * Learn the fundamentals of exporting a PyTorch `nn.Module` to ExecuTorch, and
34*523fa7a6SAndroid Build Coastguard Worker    optimizing its performance using quantization and hardware delegation.
35*523fa7a6SAndroid Build Coastguard Worker* Running LLaMA on
36*523fa7a6SAndroid Build Coastguard Worker  [iOS](https://pytorch.org/executorch/stable/llm/llama-demo-ios.html) and
37*523fa7a6SAndroid Build Coastguard Worker  [Android](https://pytorch.org/executorch/stable/llm/llama-demo-android.html)
38*523fa7a6SAndroid Build Coastguard Worker  devices.
39*523fa7a6SAndroid Build Coastguard Worker  * Build and run LLaMA in a demo mobile app, and learn how to integrate models
40*523fa7a6SAndroid Build Coastguard Worker    with your own apps.
41