Skip to content

Commit 82cf123

Browse files
Arm backend: Fix stale docgen generation pt.2 (pytorch#19685)
Port doc changes from 12bb0e7 from pure md-files to md.in stubs. Signed-off-by: Adrian Lundell <adrian.lundell@arm.com>
1 parent 885ebb9 commit 82cf123

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ ExecuTorch for the Ethos-U backend, you automatically install the compiler conta
153153

154154
**→{doc}`/backends/arm-ethos-u/arm-ethos-u-troubleshooting` — Troubleshooting and common issues.**
155155

156-
**→{doc}`/backends/arm-ethos-u/tutorials/arm-ethos-u-tutorials` — Tutorials.**
156+
**→{doc}`/backends/arm-ethos-u/tutorials/ethos-u-getting-started` — Getting started tutorial.**
157157

158158
**→{doc}`/backends/arm-ethos-u/U55_op_support` — Ethos-U55 supported operators.**
159159

@@ -168,7 +168,7 @@ ExecuTorch for the Ethos-U backend, you automatically install the compiler conta
168168
arm-ethos-u-partitioner
169169
arm-ethos-u-quantization
170170
arm-ethos-u-troubleshooting
171-
tutorials/arm-ethos-u-tutorials
171+
tutorials/ethos-u-getting-started
172172
U55_op_support
173173
U85_op_support
174174
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ described in the rest of this guide but with a concrete end-to-end sample.
7979

8080
**→{doc}`/backends/arm-vgf/arm-vgf-troubleshooting` — Debug common issues.**
8181

82-
**→{doc}`/backends/arm-vgf/tutorials/arm-vgf-tutorials` — Tutorials.**
82+
**→{doc}`/backends/arm-vgf/tutorials/vgf-getting-started` — Getting started tutorial.**
8383

8484
**→{doc}`/backends/arm-vgf/VGF_op_support` — VGF supported operators.**
8585

@@ -92,6 +92,6 @@ described in the rest of this guide but with a concrete end-to-end sample.
9292
arm-vgf-partitioner
9393
arm-vgf-quantization
9494
arm-vgf-troubleshooting
95-
tutorials/arm-vgf-tutorials
95+
tutorials/vgf-getting-started
9696
VGF_op_support
9797
```

backends/arm/scripts/docgen/vgf/vgf-getting-started-tutorial.md.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ To produce a pte file equivalent to the one above, run
8383
`python -m backends.arm.scripts.aot_arm_compiler --model_name=add --delegate --quantize --output=simple_example.pte --target=vgf`
8484
```
8585

86-
### Runtime:
86+
## Runtime
8787

88-
## Build executor runtime
88+
### Build executor runtime
8989

9090
After the AOT compilation flow is done, we can build the executor runner target. For this tutorial, the default runner can be used. Build it with the following configuration:
9191

@@ -115,7 +115,7 @@ The block diagram below demonstrates, at the high level, how the various build a
115115
![](arm-delegate-runtime-build.svg)
116116

117117

118-
## Deploying and running on device
118+
### Deploying and running on device
119119

120120
Since we are using the Vulkan emulation layer, we can run the executor runner with the VGF delegate on the host machine:
121121

0 commit comments

Comments
 (0)