Skip to content

Commit 2414b2d

Browse files
committed
Follow consistent ordering in examples/README.md (#937)
Summary: Pull Request resolved: #937 Similar to tutorials ordering. core parts, sdk, demo apps, xnnpack, 3p backends Reviewed By: dbort Differential Revision: D50308963 fbshipit-source-id: 766949e89c4c280098c5ae8bcd83c75aa77feaab
1 parent fff8f43 commit 2414b2d

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

examples/README.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,18 @@ ExecuTorch's extensive support spans from simple modules like "Add" to comprehen
99
## Directory structure
1010
```
1111
examples
12-
├── apple
13-
| ├── mps # Contains end-to-end demos of MPS backend
1412
├── models # Contains a set of popular and representative PyTorch models
1513
├── 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
1714
├── 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
1821
├── arm # Contains demos of the Arm TOSA and Ethos-U NPU flows
1922
├── qualcomm # Contains demos of Qualcomm QNN backend
2023
├── 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
2524
├── third-party # Third-party libraries required for working on the demos
2625
└── README.md # This file
2726
```
@@ -32,43 +31,38 @@ examples
3231
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.
3332

3433

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-
4034
## Demo of Selective Build
4135

4236
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.
4337

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.
4441

4542
## Demo Apps
4643

4744
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.
4845

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.
4953

5054
## Demo of ExecuTorch on ARM Cortex-M55 + Ethos-U55
5155

5256
The [`arm/`](./arm) directory contains scripts to help you run a PyTorch model on a ARM Corstone-300 platform via ExecuTorch.
5357

54-
5558
## Demo of ExecuTorch QNN Backend
5659

5760
You will find demos of [ExecuTorch QNN Backend](./qualcomm) in the [`qualcomm/`](./qualcomm) directory.
5861

59-
60-
## Demo of ExecuTorch on Xtensa Hifi4 DSP
62+
## Demo of ExecuTorch on Xtensa HiFi4 DSP
6163

6264
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.
6365

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-
7266
## Dependencies
7367

7468
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

Comments
 (0)