Skip to content

convert to .md and clean up content on main docs page #9776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
287 changes: 287 additions & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
(home)=
# Welcome to the ExecuTorch Documentation

**ExecuTorch** is PyTorch's solution to training and inference on the
Edge.

## Key Value Propositions

- **Portability:** Compatibility with a wide variety of computing
platforms, from high-end mobile phones to highly constrained
embedded systems and microcontrollers.
- **Productivity:** Enabling developers to use the same toolchains and
Developer Tools from PyTorch model authoring and conversion, to
debugging and deployment to a wide variety of platforms.
- **Performance:** Providing end users with a seamless and
high-performance experience due to a lightweight runtime and
utilizing full hardware capabilities such as CPUs, NPUs, and DSPs.

ExecuTorch provides support for:

* **Strong Model Support** LLMs (Large Language Models),
CV (Computer Vision), ASR (Automatic Speech Recognition), TTS (Text To Speech)
* **All Major Platforms** Android, Mac, Linux, Windows
* **Rich Acceleration Support** Apple, Arm, Cadence, MediaTek,
Qualcomm, Vulkan, XNNPACK

### Documentation Navigation
#### Introduction
- [Overview](intro-overview)
- [How it Works](intro-how-it-works)
- [Getting Started with Architecture](getting-started-architecture)
- [Concepts](concepts)
#### Usage
- [Getting Started](getting-started)
- [Using Executorch Export](using-executorch-export)
- [Using Executorch on Android](using-executorch-android)
- [Using Executorch on iOS](using-executorch-ios)
- [Using Executorch with C++](using-executorch-cpp)
- [Runtime Integration](using-executorch-runtime-integration)
- [Troubleshooting](using-executorch-troubleshooting)
- [Building from Source](using-executorch-building-from-source)
- [FAQs](using-executorch-faqs)
#### Examples
- [Android Demo Apps](demo-apps-android.md)
- [iOS Demo Apps](demo-apps-ios.md)
#### Backends
- [Overview](backends-overview)
- [XNNPACK](backends-xnnpack)
- [Core ML](backends-coreml)
- [MPS](backends-mps)
- [Vulkan](backends-vulkan)
- [ARM Ethos-U](backends-arm-ethos-u)
- [Qualcomm](backends-qualcomm)
- [MediaTek](backends-mediatek)
- [Cadence](backends-cadence)
#### Developer Tools
- [Overview](devtools-overview)
- [Bundled IO](bundled-io)
- [ETRecord](etrecord)
- [ETDump](etdump)
- [Runtime Profiling](runtime-profiling)
- [Model Debugging](model-debugging)
- [Model Inspector](model-inspector)
- [Memory Planning Inspection](memory-planning-inspection)
- [Delegate Debugging](delegate-debugging)
- [Tutorial](devtools-tutorial)
#### Runtime
- [Overview](runtime-overview)
- [Extension Module](extension-module)
- [Extension Tensor](extension-tensor)
- [Running a Model (C++ Tutorial)](running-a-model-cpp-tutorial)
- [Backend Delegate Implementation and Linking](runtime-backend-delegate-implementation-and-linking)
- [Platform Abstraction Layer](runtime-platform-abstraction-layer)
#### Portable C++ Programming
- [PTE File Format](pte-file-format)
#### API Reference
- [Export to Executorch API Reference](export-to-executorch-api-reference)
- [Executorch Runtime API Reference](executorch-runtime-api-reference)
- [Runtime Python API Reference](runtime-python-api-reference)
- [API Life Cycle](api-life-cycle)
- [Javadoc](https://pytorch.org/executorch/main/javadoc/)
#### Quantization
- [Overview](quantization-overview)
#### Kernel Library
- [Overview](kernel-library-overview)
- [Custom ATen Kernel](kernel-library-custom-aten-kernel)
- [Selective Build](kernel-library-selective-build)
#### Working with LLMs
- [Llama](llm/llama)
- [Llama on Android](llm/llama-demo-android)
- [Llama on iOS](llm/llama-demo-ios)
- [Llama on Android via Qualcomm backend](llm/build-run-llama3-qualcomm-ai-engine-direct-backend)
- [Intro to LLMs in Executorch](llm/getting-started)
#### Backend Development
- [Delegates Integration](backend-delegates-integration)
- [XNNPACK Reference](backend-delegates-xnnpack-reference)
- [Dependencies](backend-delegates-dependencies)
- [Compiler Delegate and Partitioner](compiler-delegate-and-partitioner)
- [Debug Backend Delegate](debug-backend-delegate)
#### IR Specification
- [EXIR](ir-exir)
- [Ops Set Definition](ir-ops-set-definition)
#### Compiler Entry Points
- [Backend Dialect](compiler-backend-dialect)
- [Custom Compiler Passes](compiler-custom-compiler-passes)
- [Memory Planning](compiler-memory-planning)
#### Contributing
- [Contributing](contributing)

```{toctree}
:glob:
:maxdepth: 1
:caption: Introduction
:hidden:

intro-overview
intro-how-it-works
getting-started-architecture
concepts
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Usage
:hidden:

getting-started
using-executorch-export
using-executorch-android
using-executorch-ios
using-executorch-cpp
using-executorch-runtime-integration
using-executorch-troubleshooting
using-executorch-building-from-source
using-executorch-faqs
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Examples
:hidden:

demo-apps-android.md
demo-apps-ios.md
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Backends
:hidden:

backends-overview
backends-xnnpack
backends-coreml
backends-mps
backends-vulkan
backends-arm-ethos-u
backends-qualcomm
backends-mediatek
backends-cadence
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Developer Tools
:hidden:

devtools-overview
bundled-io
etrecord
etdump
runtime-profiling
model-debugging
model-inspector
memory-planning-inspection
delegate-debugging
devtools-tutorial
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Runtime
:hidden:

runtime-overview
extension-module
extension-tensor
running-a-model-cpp-tutorial
runtime-backend-delegate-implementation-and-linking
runtime-platform-abstraction-layer
portable-cpp-programming
pte-file-format
```

```{toctree}
:glob:
:maxdepth: 1
:caption: API Reference
:hidden:

export-to-executorch-api-reference
executorch-runtime-api-reference
runtime-python-api-reference
api-life-cycle
Javadoc <https://pytorch.org/executorch/main/javadoc/>
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Quantization
:hidden:

quantization-overview
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Kernel Library
:hidden:

kernel-library-overview
kernel-library-custom-aten-kernel
kernel-library-selective-build
```

```{toctree}
:glob:
:maxdepth: 2
:caption: Working with LLMs
:hidden:

Llama <llm/llama>
Llama on Android <llm/llama-demo-android>
Llama on iOS <llm/llama-demo-ios>
Llama on Android via Qualcomm backend <llm/build-run-llama3-qualcomm-ai-engine-direct-backend>
Intro to LLMs in Executorch <llm/getting-started>
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Backend Development
:hidden:

backend-delegates-integration
backend-delegates-xnnpack-reference
backend-delegates-dependencies
compiler-delegate-and-partitioner
debug-backend-delegate
```

```{toctree}
:glob:
:maxdepth: 1
:caption: IR Specification
:hidden:

ir-exir
ir-ops-set-definition
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Compiler Entry Points
:hidden:

compiler-backend-dialect
compiler-custom-compiler-passes
compiler-memory-planning
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Contributing
:hidden:

contributing
```
Loading
Loading