You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/README.md
+17-23Lines changed: 17 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,18 @@ ExecuTorch's extensive support spans from simple modules like "Add" to comprehen
9
9
## Directory structure
10
10
```
11
11
examples
12
-
├── apple
13
-
| ├── mps # Contains end-to-end demos of MPS backend
14
12
├── models # Contains a set of popular and representative PyTorch models
15
13
├── portable # Contains end-to-end demos for ExecuTorch in portable mode
16
-
├── xnnpack # Contains end-to-end ExecuTorch demos with first-party optimization using XNNPACK
17
14
├── selective_build # Contains demos of selective build for optimizing the binary size of the ExecuTorch runtime
15
+
├── sdk # Contains demos of BundledProgram and ETDump
16
+
├── demo-apps # Contains demo apps for Android and iOS
17
+
├── xnnpack # Contains end-to-end ExecuTorch demos with first-party optimization using XNNPACK
18
+
├── apple
19
+
| |── coreml # Contains demos of Apple's CoreML backend
20
+
| └── mps # Contains end-to-end demos of MPS backend
18
21
├── arm # Contains demos of the Arm TOSA and Ethos-U NPU flows
19
22
├── qualcomm # Contains demos of Qualcomm QNN backend
20
23
├── xtensa # Contains demos of exporting and running a simple model on Xtensa Hifi4 DSP
21
-
├── apple
22
-
| └── coreml # Contains demos of Apple's CoreML backend
23
-
├── demo-apps # Contains demo apps for Android and iOS
24
-
├── sdk # Contains demos of BundledProgram and ETDump
25
24
├── third-party # Third-party libraries required for working on the demos
26
25
└── README.md # This file
27
26
```
@@ -32,43 +31,38 @@ examples
32
31
A user's journey may commence by exploring the demos located in the [`portable/`](./portable) directory. Here, you will gain insights into the fundamental end-to-end workflow to generate a binary file from a ML model in [portable mode](/docs/website/docs/basics/terminology.md) and run it on the ExecuTorch runtime.
33
32
34
33
35
-
## Demo of XNNPACK delegation
36
-
37
-
The demos in the [`xnnpack/`](./xnnpack) directory provide valuable insights into the process of lowering and executing an ExecuTorch model with built-in performance enhancements. These demos specifically showcase the workflow involving [XNNPACK backend](https://github.com/pytorch/executorch/tree/main/backends/xnnpack) delegation and quantization.
38
-
39
-
40
34
## Demo of Selective Build
41
35
42
36
To understand how to deploy the ExecuTorch runtime with optimization for binary size, explore the demos available in the [`selective_build/`](./selective_build) directory. These demos are specifically designed to illustrate the [Selective Build](/docs/website/docs/tutorials/selective_build.md), offering insights into reducing the binary size while maintaining efficiency.
43
37
38
+
## Demo of ExecuTorch SDK
39
+
40
+
You will find demos of [ExecuTorch SDK](./sdk/) in the [`sdk/`](./sdk/) directory. The examples focuses on exporting and executing BundledProgram for ExecuTorch model verification, and ETDump generation.
44
41
45
42
## Demo Apps
46
43
47
44
Explore mobile apps with ExecuTorch models integrated and deployable on Android and iOS in the [`demo-apps/android/`](./demo-apps/android) and [`demo-apps/apple_ios/`](./demo-apps/apple_ios) directories, respectively.
48
45
46
+
## Demo of XNNPACK delegation
47
+
48
+
The demos in the [`xnnpack/`](./xnnpack) directory provide valuable insights into the process of lowering and executing an ExecuTorch model with built-in performance enhancements. These demos specifically showcase the workflow involving [XNNPACK backend](https://github.com/pytorch/executorch/tree/main/backends/xnnpack) delegation and quantization.
49
+
50
+
## Demo of ExecuTorch Apple Backend
51
+
52
+
You will find demos of [ExecuTorch CoreML Backend](./apple/coreml/) in the [`apple/coreml/`](./apple/coreml) directory and [MPS Backend](./apple/mps/) in the [`apple/mps/`](./apple/mps) directory.
49
53
50
54
## Demo of ExecuTorch on ARM Cortex-M55 + Ethos-U55
51
55
52
56
The [`arm/`](./arm) directory contains scripts to help you run a PyTorch model on a ARM Corstone-300 platform via ExecuTorch.
53
57
54
-
55
58
## Demo of ExecuTorch QNN Backend
56
59
57
60
You will find demos of [ExecuTorch QNN Backend](./qualcomm) in the [`qualcomm/`](./qualcomm) directory.
58
61
59
-
60
-
## Demo of ExecuTorch on Xtensa Hifi4 DSP
62
+
## Demo of ExecuTorch on Xtensa HiFi4 DSP
61
63
62
64
The [`xtensa/`](./xtensa) directory hosts a demo that showcases the process of exporting and executing a model on Xtensa Hifi4 DSP. You can utilize [this tutorial](../docs/source/build-run-xtensa.md) to guide you in configuring the demo and running it.
63
65
64
-
## Demo of ExecuTorch Apple Backend
65
-
66
-
You will find demos of [ExecuTorch CoreML Backend](./apple/coreml/) in the [`apple/coreml/`](./apple/coreml) directory.
67
-
68
-
## Demo of ExecuTorch SDK
69
-
70
-
You will find demos of [ExecuTorch SDK](./sdk/) in the [`sdk/`](./sdk/) directory. The examples focuses on exporting and executing BundledProgram for ExecuTorch model verification, and ETDump generation.
71
-
72
66
## Dependencies
73
67
74
68
Various models and workflows listed in this directory have dependencies on some other packages. You need to follow the setup guide in [Setting up ExecuTorch from GitHub](/docs/website/docs/tutorials/00_setting_up_executorch.md) to have appropriate packages installed.
0 commit comments