Skip to content

Commit f02fab4

Browse files
authored
Resurface low level runtime API page (#13651)
See #13631
1 parent ea18317 commit f02fab4

File tree

7 files changed

+7
-7
lines changed

7 files changed

+7
-7
lines changed

docs/source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,6 @@
202202
"export-overview": "using-executorch-export.html",
203203
"runtime-build-and-cross-compilation": "using-executorch-building-from-source.html",
204204
"tutorials/export-to-executorch-tutorial": "../using-executorch-export.html",
205-
"running-a-model-cpp-tutorial": "using-executorch-cpp.html",
206205
"build-run-vulkan": "backends-vulkan.html",
207206
"executorch-arm-delegate-tutorial": "backends-arm-ethos-u.html",
208207
"build-run-coreml": "backends-coreml.html",

docs/source/executorch-runtime-api-reference.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Runtime API Reference
44
The ExecuTorch C++ API provides an on-device execution framework for exported PyTorch models.
55

66
For a tutorial style introduction to the runtime API, check out the
7-
`runtime tutorial <running-a-model-cpp-tutorial.html>`__ and its `simplified <extension-module.html>`__ version.
7+
`using executorch with cpp tutorial <using-executorch-cpp.html>`__ and its `simplified <extension-module.html>`__ version.
88

99
For detailed information on how APIs evolve and the deprecation process, please refer to the `ExecuTorch API Life Cycle and Deprecation Policy <api-life-cycle.html>`__.
1010

docs/source/extension-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Author:** [Anthony Shoumikhin](https://github.com/shoumikhin)
44

5-
In the [Running an ExecuTorch Model in C++ Tutorial](running-a-model-cpp-tutorial.md), we explored the lower-level ExecuTorch APIs for running an exported model. While these APIs offer zero overhead, great flexibility, and control, they can be verbose and complex for regular use. To simplify this and resemble PyTorch's eager mode in Python, we introduce the `Module` facade APIs over the regular ExecuTorch runtime APIs. The `Module` APIs provide the same flexibility but default to commonly used components like `DataLoader` and `MemoryAllocator`, hiding most intricate details.
5+
In the [Detailed C++ Runtime APIs Tutorial](running-a-model-cpp-tutorial.md), we explored the lower-level ExecuTorch APIs for running an exported model. While these APIs offer zero overhead, great flexibility, and control, they can be verbose and complex for regular use. To simplify this and resemble PyTorch's eager mode in Python, we introduce the `Module` facade APIs over the regular ExecuTorch runtime APIs. The `Module` APIs provide the same flexibility but default to commonly used components like `DataLoader` and `MemoryAllocator`, hiding most intricate details.
66

77
## Example
88

docs/source/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ ExecuTorch provides support for:
7171
- [Overview](runtime-overview)
7272
- [Extension Module](extension-module)
7373
- [Extension Tensor](extension-tensor)
74-
- [Running a Model (C++ Tutorial)](running-a-model-cpp-tutorial)
74+
- [Detailed C++ Runtime APIs Tutorial](running-a-model-cpp-tutorial)
7575
- [Backend Delegate Implementation and Linking](runtime-backend-delegate-implementation-and-linking)
7676
- [Platform Abstraction Layer](runtime-platform-abstraction-layer)
7777
#### Portable C++ Programming

docs/source/running-a-model-cpp-tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Running an ExecuTorch Model in C++ Tutorial
1+
# Detailed C++ Runtime APIs Tutorial
22

33
**Author:** [Jacob Szwejbka](https://github.com/JacobSzwejbka)
44

5-
In this tutorial, we will cover how to run an ExecuTorch model in C++ using the more detailed, lower-level APIs: prepare the `MemoryManager`, set inputs, execute the model, and retrieve outputs. However, if you’re looking for a simpler interface that works out of the box, consider trying the [Module Extension Tutorial](extension-module.md).
5+
In this tutorial, we will cover how to run an ExecuTorch model in C++ using the more detailed, lower-level APIs: prepare the `MemoryManager`, set inputs, execute the model, and retrieve outputs. However, if you’re looking for a simpler interface that works out of the box, consider trying the [Module Extension Tutorial](extension-module.md) and [Using ExecuTorch with C++](using-executorch-cpp.md).
66

77
For a high level overview of the ExecuTorch Runtime please see [Runtime Overview](runtime-overview.md), and for more in-depth documentation on
88
each API please see the [Runtime API Reference](executorch-runtime-api-reference.rst).

docs/source/runtime-overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ However, please note:
155155

156156
For more details about the ExecuTorch runtime, please see:
157157

158+
* [Using ExecuTorch with C++](using-executorch-cpp.md)
158159
* [Detailed Runtime APIs Tutorial](running-a-model-cpp-tutorial.md)
159160
* [Simplified Runtime APIs Tutorial](extension-module.md)
160161
* [Building from Source](using-executorch-building-from-source.md)

docs/source/using-executorch-cpp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For complete examples of building and running a C++ application using the Module
3636
3737
## Low-Level APIs
3838
39-
Running a model using the low-level runtime APIs allows for a high-degree of control over memory allocation, placement, and loading. This allows for advanced use cases, such as placing allocations in specific memory banks or loading a model without a file system. For an end to end example using the low-level runtime APIs, see [Running an ExecuTorch Model in C++ Tutorial](running-a-model-cpp-tutorial.md).
39+
Running a model using the low-level runtime APIs allows for a high-degree of control over memory allocation, placement, and loading. This allows for advanced use cases, such as placing allocations in specific memory banks or loading a model without a file system. For an end to end example using the low-level runtime APIs, see [Detailed C++ Runtime APIs Tutorial](running-a-model-cpp-tutorial.md).
4040
4141
## Building with CMake
4242

0 commit comments

Comments
 (0)