Skip to content

Commit cb670b3

Browse files
usamahzpytorchbot
authored andcommitted
Arm backend: document Ethos-U & VGF image examples (#18156)
Document Ethos-U & VGF image examples Signed-off-by: Usamah Zaheer <usamah.zaheer@arm.com> (cherry picked from commit 6c02866)
1 parent b3c3164 commit cb670b3

File tree

4 files changed

+53
-0
lines changed

4 files changed

+53
-0
lines changed

backends/arm/scripts/docgen/ethos-u/backends-arm-ethos-u-overview.md.in

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,14 @@ An example runtime application is available in [examples/arm/executor_runner](ht
5959
The example application is recommended to use for testing basic functionality of your lowered models, as well as a starting point for developing runtime integrations for your own targets.
6060
For an in-depth explanation of the architecture of the executor_runner and the steps required for doing such an integration, please refer to [Ethos-U porting guide](https://github.com/pytorch/executorch/blob/main/examples/arm/ethos-u-porting-guide.md).
6161

62+
### Example: Image classification flow
63+
64+
[`examples/arm/image_classification_example_ethos_u`](https://github.com/pytorch/executorch/tree/main/examples/arm/image_classification_example_ethos_u)
65+
contains a complete DeiT-based export and runtime walkthrough. The README shows
66+
how to run `model_export/export_deit.py`, build the sample firmware, and convert
67+
test images into C arrays so the workflow described in this guide can be tried
68+
end to end.
69+
6270
### Ethos-U memory modes
6371

6472
The Ethos-U NPU provides two distinct memory interfaces:
@@ -147,6 +155,10 @@ ExecuTorch for the Ethos-U backend, you automatically install the compiler conta
147155

148156
**→{doc}`/backends/arm-ethos-u/tutorials/arm-ethos-u-tutorials` — Tutorials.**
149157

158+
**→{doc}`/backends/arm-ethos-u/U55_op_support` — Ethos-U55 supported operators.**
159+
160+
**→{doc}`/backends/arm-ethos-u/U85_op_support` — Ethos-U85 supported operators.**
161+
150162

151163
```{toctree}
152164
:maxdepth: 2
@@ -157,4 +169,6 @@ arm-ethos-u-partitioner
157169
arm-ethos-u-quantization
158170
arm-ethos-u-troubleshooting
159171
tutorials/arm-ethos-u-tutorials
172+
U55_op_support
173+
U85_op_support
160174
```

backends/arm/scripts/docgen/vgf/backends-arm-vgf-overview.md.in

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,21 @@ For more information on quantization, see [Quantization](arm-vgf-quantization.md
5656
The VGF backend can use the default ExecuTorch runner. The steps required for building and running it are explained in the [VGF Backend Tutorial](tutorials/vgf-getting-started.md). <!-- @lint-ignore -->
5757
The example application is recommended to use for testing basic functionality of your lowered models, as well as a starting point for developing runtime integrations for your own targets.
5858

59+
### Example: Image classification flow
60+
61+
[`examples/arm/image_classification_example_vgf`](https://github.com/pytorch/executorch/tree/main/examples/arm/image_classification_example_vgf)
62+
contains a ready-to-run DeiT image classification pipeline for VGF targets.
63+
The example README documents how to:
64+
65+
- Export the quantized INT8 weights via `model_export/export_deit.py`.
66+
- Use the provided requirements file to install the ML SDK converter scripts
67+
and produce a `.pte` artifact.
68+
- Build and launch the Vulkan-based runtime under `runtime/`, which loads the
69+
`.pte` alongside the generated VGF blob.
70+
71+
Following this walkthrough ensures you exercise the same lowering + runtime flow
72+
described in the rest of this guide but with a concrete end-to-end sample.
73+
5974
## Reference
6075

6176
**→{doc}`/backends/arm-vgf/arm-vgf-partitioner` — Partitioner options.**

docs/source/backends/arm-ethos-u/arm-ethos-u-overview.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,14 @@ An example runtime application is available in [examples/arm/executor_runner](ht
137137
The example application is recommended to use for testing basic functionality of your lowered models, as well as a starting point for developing runtime integrations for your own targets.
138138
For an in-depth explanation of the architecture of the executor_runner and the steps required for doing such an integration, please refer to [Ethos-U porting guide](https://github.com/pytorch/executorch/blob/main/examples/arm/ethos-u-porting-guide.md).
139139

140+
### Example: Image classification flow
141+
142+
[`examples/arm/image_classification_example_ethos_u`](https://github.com/pytorch/executorch/tree/main/examples/arm/image_classification_example_ethos_u)
143+
contains a complete DeiT-based export and runtime walkthrough. The README shows
144+
how to run `model_export/export_deit.py`, build the sample firmware, and convert
145+
test images into C arrays so the workflow described in this guide can be tried
146+
end to end.
147+
140148
### Ethos-U memory modes
141149

142150
The Ethos-U NPU provides two distinct memory interfaces:
@@ -229,6 +237,7 @@ ExecuTorch for the Ethos-U backend, you automatically install the compiler conta
229237

230238
**→{doc}`/backends/arm-ethos-u/U85_op_support` — Ethos-U85 supported operators.**
231239

240+
232241
```{toctree}
233242
:maxdepth: 2
234243
:hidden:

docs/source/backends/arm-vgf/arm-vgf-overview.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,21 @@ For more information on quantization, see [Quantization](arm-vgf-quantization.md
128128
The VGF backend can use the default ExecuTorch runner. The steps required for building and running it are explained in the [VGF Backend Tutorial](tutorials/vgf-getting-started.md). <!-- @lint-ignore -->
129129
The example application is recommended to use for testing basic functionality of your lowered models, as well as a starting point for developing runtime integrations for your own targets.
130130

131+
### Example: Image classification flow
132+
133+
[`examples/arm/image_classification_example_vgf`](https://github.com/pytorch/executorch/tree/main/examples/arm/image_classification_example_vgf)
134+
contains a ready-to-run DeiT image classification pipeline for VGF targets.
135+
The example README documents how to:
136+
137+
- Export the quantized INT8 weights via `model_export/export_deit.py`.
138+
- Use the provided requirements file to install the ML SDK converter scripts
139+
and produce a `.pte` artifact.
140+
- Build and launch the Vulkan-based runtime under `runtime/`, which loads the
141+
`.pte` alongside the generated VGF blob.
142+
143+
Following this walkthrough ensures you exercise the same lowering + runtime flow
144+
described in the rest of this guide but with a concrete end-to-end sample.
145+
131146
## Reference
132147

133148
**→{doc}`/backends/arm-vgf/arm-vgf-partitioner` — Partitioner options.**

0 commit comments

Comments
 (0)