Skip to content

Commit 226c1c5

Browse files
authored
[DOC] Add redirects for moved ExecuTorch pages (pytorch#19338)
Fixes pytorch#14797 ### Summary - Add redirects for moved top-level backend, LLM, and tutorial pages. - Point existing Core ML, MPS, and Arm Ethos-U redirects at their current canonical pages. - Update stale internal doc links, including the Tools Model Visualization entry. - Keep Samsung Exynos in Android navigation through the Android wrapper while preserving the Backends section order so Cadence points next to Samsung. ### Test plan - `git diff --check` - `python -m py_compile docs/source/conf.py` - Redirect-target script: checked 23 redirects, no missing targets - Parsed redirect table: confirmed `llm/llama-demo-android` resolves to `docs/source/using-executorch-android.md` - `PYTHONPATH=/tmp/executorch-doc-stub:.. ../.venv/bin/sphinx-build -D plot_gallery=0 -b html docs/source /tmp/executorch-docs-14797-final-escalated` succeeded with existing repository warnings before the follow-up redirect entry - Verified rendered `backends-cadence.html` next page is Samsung Exynos - Verified generated redirects for `backends-arm-ethos-u.html`, `backends-coreml.html`, `backends-mps.html`, and `visualization.html` cc @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell
1 parent 1643611 commit 226c1c5

7 files changed

Lines changed: 27 additions & 16 deletions

File tree

docs/source/android-backends.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Available hardware acceleration backends for Android deployment.
1616
- {doc}`android-qualcomm` — Qualcomm AI Engine (NPU)
1717
- {doc}`android-mediatek` — MediaTek NPU acceleration
1818
- {doc}`android-arm-vgf` — ARM VGF Backend
19-
- {doc}`backends/samsung/samsung-overview` — Samsung Exynos NPU
19+
- {doc}`android-samsung-exynos` — Samsung Exynos NPU
2020

2121
```{toctree}
2222
:hidden:
@@ -25,4 +25,5 @@ android-vulkan
2525
android-qualcomm
2626
android-mediatek
2727
android-arm-vgf
28-
backends/samsung/samsung-overview
28+
android-samsung-exynos
29+
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Arm® Ethos™-U backend targets Edge/IoT-type AI use-cases by enabli
44
[Arm® Ethos™-U55 NPU](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u55), [Arm® Ethos™-U65 NPU](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u65), and
55
[Arm® Ethos™-U85 NPU](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u85), leveraging [TOSA](https://www.mlplatform.org/tosa/) and the
66
[ethos-u-vela](https://pypi.org/project/ethos-u-vela/) graph compiler. This document is a technical reference for using the Ethos-U backend, for a top level view with code examples
7-
please refer to the [Arm Ethos-U Backend Tutorial](https://docs.pytorch.org/executorch/stable/tutorial-arm-ethos-u.html).
7+
please refer to the [Arm Ethos-U Backend Tutorial](tutorials/ethos-u-getting-started.md).
88

99
## Features
1010

@@ -111,7 +111,7 @@ For more information on quantization, see [Quantization](arm-ethos-u-quantizatio
111111

112112
## Runtime Integration
113113

114-
An example runtime application is available in [examples/arm/executor_runner](https://github.com/pytorch/executorch/blob/main/examples/arm/executor_runner/), and the steps requried for building and deploying it on a FVP it is explained in the previously mentioned [Arm Ethos-U Backend Tutorial](https://docs.pytorch.org/executorch/stable/tutorial-arm-ethos-u.html).
114+
An example runtime application is available in [examples/arm/executor_runner](https://github.com/pytorch/executorch/blob/main/examples/arm/executor_runner/), and the steps requried for building and deploying it on a FVP it is explained in the previously mentioned [Arm Ethos-U Backend Tutorial](tutorials/ethos-u-getting-started.md).
115115
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.
116116
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).
117117

docs/source/conf.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -283,13 +283,23 @@
283283
"tutorials/export-to-executorch-tutorial": "../using-executorch-export.html",
284284
"build-run-vulkan": "backends/vulkan/vulkan-overview.html",
285285
"backends-vulkan": "backends/vulkan/vulkan-overview.html",
286-
"executorch-arm-delegate-tutorial": "backends-arm-ethos-u.html",
287-
"build-run-coreml": "backends-coreml.html",
286+
"executorch-arm-delegate-tutorial": "backends/arm-ethos-u/tutorials/ethos-u-getting-started.html",
287+
"build-run-coreml": "backends/coreml/coreml-overview.html",
288288
"build-run-mediatek-backend": "backends-mediatek.html",
289-
"build-run-mps": "backends-mps.html",
289+
"build-run-mps": "backends/mps/mps-overview.html",
290290
"build-run-qualcomm-ai-engine-direct-backend": "backends-qualcomm.html",
291291
"build-run-xtensa": "backends-cadence.html",
292292
"apple-runtime": "using-executorch-ios.html",
293+
"backends-arm-ethos-u": "backends/arm-ethos-u/arm-ethos-u-overview.html",
294+
"backends-arm-vgf": "backends/arm-vgf/arm-vgf-overview.html",
295+
"backends-coreml": "backends/coreml/coreml-overview.html",
296+
"backends-mps": "backends/mps/mps-overview.html",
297+
"backends-xnnpack": "backends/xnnpack/xnnpack-overview.html",
298+
"backend-delegates-xnnpack-reference": "backends/xnnpack/xnnpack-arch-internals.html",
299+
"llm/llama-demo-android": "../using-executorch-android.html",
300+
"tutorial-arm-ethos-u": "backends/arm-ethos-u/tutorials/ethos-u-getting-started.html",
301+
"tutorial-arm-vgf": "backends/arm-vgf/tutorials/vgf-getting-started.html",
302+
"visualization": "visualize.html",
293303
}
294304

295305
# Custom directives defintions to create cards on main landing page

docs/source/platforms-desktop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ ExecuTorch supports desktop and laptop deployment across Linux, macOS, and Windo
1111
### Linux
1212
- [XNNPACK (CPU)](backends/xnnpack/xnnpack-overview.md)
1313
- [OpenVINO (Intel)](build-run-openvino)
14-
- [ARM Ethos-U (ARM64)](backends-arm-ethos-u)
14+
- [ARM Ethos-U (ARM64)](backends/arm-ethos-u/arm-ethos-u-overview.md)
1515

1616
### macOS
17-
- [CoreML (recommended)](backends-coreml)
18-
- [MPS (Apple Silicon)](backends-mps)
17+
- [Core ML (recommended)](backends/coreml/coreml-overview.md)
18+
- [MPS (Apple Silicon)](backends/mps/mps-overview.md)
1919
- [XNNPACK (CPU)](backends/xnnpack/xnnpack-overview.md)
2020

2121
### Windows

docs/source/platforms-embedded.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ ExecuTorch supports embedded devices from microcontrollers to edge devices.
1010

1111
### Microcontrollers
1212
- [Cadence Xtensa Backend](backends-cadence)
13-
- [ARM Ethos-U NPU Backend](backends-arm-ethos-u)
13+
- [ARM Ethos-U NPU Backend](backends/arm-ethos-u/arm-ethos-u-overview.md)
1414
- [Custom Backend Development](backend-delegates-integration)
1515

1616
### Edge Devices
17-
- [ARM Ethos-U NPU Backend](backends-arm-ethos-u)
18-
- [NXP eIQ Neutron Backend](backend-nxp)
17+
- [ARM Ethos-U NPU Backend](backends/arm-ethos-u/arm-ethos-u-overview.md)
18+
- [NXP eIQ Neutron Backend](backends/nxp/nxp-overview.md)
1919
- [Custom Hardware Integration](backend-delegates-integration)

docs/source/tools-section.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In this section, explore ExecuTorch's comprehensive developer tools for profilin
1313
- {doc}`model-inspector` — Model Inspector
1414
- {doc}`memory-planning-inspection` — Memory Planning Inspection
1515
- {doc}`devtools-tutorial` — Development Utilities
16-
- {doc}`visualization` — Model Visualization
16+
- {doc}`visualize` — Model Visualization
1717

1818
```{toctree}
1919
:hidden:
@@ -29,4 +29,4 @@ model-debugging
2929
model-inspector
3030
memory-planning-inspection
3131
devtools-tutorial
32-
visualization
32+
visualize

docs/source/using-executorch-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Commonly used hardware backends are listed below. For mobile, consider using XNN
3838
- [Vulkan (Android GPU)](backends/vulkan/vulkan-overview.md)
3939
- [Qualcomm NPU](backends-qualcomm.md)
4040
- [MediaTek NPU](backends-mediatek.md)
41-
- [Arm Ethos-U NPU](backends-arm-ethos-u.md)
41+
- [Arm Ethos-U NPU](backends/arm-ethos-u/arm-ethos-u-overview.md)
4242
- [Cadence DSP](backends-cadence.md)
4343

4444
## Model Preparation

0 commit comments

Comments
 (0)