Skip to content

Commit d173f36

Browse files
committed
Restructure ET documentation with 'Platform First' model
1 parent d4d24ec commit d173f36

10 files changed

+384
-72
lines changed

docs/source/android-section.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Android
2+
3+
## Quick Start & Integration
4+
[Getting started with ExecuTorch on Android](using-executorch-android)
5+
6+
## Available Backends
7+
8+
### CPU Backends
9+
- [XNNPACK Backend](backends-xnnpack) - Optimized CPU inference
10+
11+
### GPU Backends
12+
- [Vulkan Backend](backends-vulkan) - Cross-platform GPU acceleration
13+
14+
### NPU/Accelerator Backends
15+
- [Qualcomm AI Engine Backend](backends-qualcomm) - Snapdragon NPU acceleration
16+
- [MediaTek Backend](backends-mediatek) - MediaTek NPU support
17+
- [Samsung Exynos Backend](backends-samsung-exynos) - Samsung NPU acceleration
18+
19+
## Working with LLMs - Android Examples
20+
21+
For comprehensive Android LLM examples and tutorials:
22+
23+
**[→ Android LLM Examples Repository](https://github.com/meta-pytorch/executorch-examples/tree/main/llm/android)**
24+
25+
This repository contains:
26+
- Complete Android LLM integration examples
27+
- Step-by-step tutorials
28+
- Sample applications
29+
- Performance benchmarks
30+
31+
## Demo Applications
32+
33+
Explore our collection of Android demo applications:
34+
35+
**[→ DeepLabV3 Demo App](https://github.com/meta-pytorch/executorch-examples/tree/main/dl3/android/DeepLabV3Demo#executorch-android-demo-app)**
36+
37+
Additional demo applications available:
38+
- Computer Vision demos
39+
- Natural Language Processing examples
40+
- Audio processing applications
41+
42+
## Troubleshooting
43+
44+
For common Android issues and solutions, see our [Troubleshooting Guide](using-executorch-troubleshooting).
45+
46+
```{toctree}
47+
:maxdepth: 1
48+
:hidden:
49+
50+
using-executorch-android
51+
backends-xnnpack
52+
backends-vulkan
53+
backends-qualcomm
54+
backends-mediatek
55+
backends-samsung-exynos
56+
using-executorch-troubleshooting
57+
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Samsung Exynos Backend (TBD)

docs/source/desktop-section.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Desktop & Laptop
2+
3+
## Platform Overview
4+
[Desktop & Laptop Platform Overview](platforms-desktop)
5+
6+
## C++ Runtime Integration
7+
[C++ Runtime Integration Guide](using-executorch-cpp)
8+
9+
## Linux
10+
### Available Backends
11+
- [XNNPACK Backend](backends-xnnpack) - CPU optimization
12+
- [Vulkan Backend](backends-vulkan) - GPU acceleration
13+
- [OpenVINO Backend](build-run-openvino) - Intel hardware optimization
14+
- [ARM Ethos-U Backend](backends-arm-ethos-u) - ARM64 NPU support
15+
16+
## macOS
17+
### Available Backends
18+
- [CoreML Backend](backends-coreml) - recommended for Apple hardware
19+
- [MPS Backend](backends-mps) - Apple Silicon GPU acceleration
20+
- [XNNPACK Backend](backends-xnnpack) - CPU optimization
21+
- [Vulkan Backend](backends-vulkan) - GPU acceleration
22+
23+
## Windows
24+
### Available Backends
25+
- [XNNPACK Backend](backends-xnnpack) - CPU optimization
26+
- [Vulkan Backend](backends-vulkan) - GPU acceleration
27+
- [OpenVINO Backend](build-run-openvino) - Intel hardware optimization
28+
29+
```{toctree}
30+
:maxdepth: 1
31+
:hidden:
32+
33+
platforms-desktop
34+
using-executorch-cpp
35+
backends-xnnpack
36+
backends-vulkan
37+
build-run-openvino
38+
backends-arm-ethos-u
39+
backends-coreml
40+
backends-mps
41+
```

docs/source/embedded-section.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Embedded
2+
3+
## Platform Overview
4+
[Embedded Platform Overview](platforms-embedded)
5+
6+
## C++ Runtime Integration
7+
[C++ Runtime Integration Guide](using-executorch-cpp)
8+
9+
## Microcontrollers
10+
- [Cadence Xtensa Backend](backends-cadence) - Xtensa processor support
11+
- [ARM Ethos-U NPU Backend](backends-arm-ethos-u) - ARM microcontroller NPU
12+
- [NXP eIQ Neutron Backend](backend-nxp) - NXP hardware optimization
13+
14+
## Custom Hardware Integration
15+
[Custom Backend Development Guide](backend-delegates-integration)
16+
17+
## WebAssembly (Coming Soon)
18+
[WebAssembly Support](using-executorch-cpp#webassembly)
19+
20+
```{toctree}
21+
:maxdepth: 1
22+
:hidden:
23+
24+
platforms-embedded
25+
using-executorch-cpp
26+
backends-cadence
27+
backends-arm-ethos-u
28+
backend-nxp
29+
backend-delegates-integration
30+
```

docs/source/fundamentals.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Fundamentals
2+
3+
## Model Export & Lowering
4+
[Learn more](using-executorch-export)
5+
6+
## Runtime Architecture
7+
[Learn more](runtime-overview)
8+
9+
## Memory Management
10+
[Learn more](compiler-memory-planning)
11+
12+
## Performance Concepts
13+
[Learn more](runtime-profiling)

0 commit comments

Comments
 (0)