Skip to content
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
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@
"export-overview": "using-executorch-export.html",
"runtime-build-and-cross-compilation": "using-executorch-building-from-source.html",
"tutorials/export-to-executorch-tutorial": "../using-executorch-export.html",
"running-a-model-cpp-tutorial": "using-executorch-cpp.html",
"build-run-vulkan": "backends-vulkan.html",
"executorch-arm-delegate-tutorial": "backends-arm-ethos-u.html",
"build-run-coreml": "backends-coreml.html",
Expand Down
2 changes: 1 addition & 1 deletion docs/source/executorch-runtime-api-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Runtime API Reference
The ExecuTorch C++ API provides an on-device execution framework for exported PyTorch models.

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

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>`__.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/extension-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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.
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.

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ ExecuTorch provides support for:
- [Overview](runtime-overview)
- [Extension Module](extension-module)
- [Extension Tensor](extension-tensor)
- [Running a Model (C++ Tutorial)](running-a-model-cpp-tutorial)
- [Detailed C++ Runtime APIs 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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/running-a-model-cpp-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Running an ExecuTorch Model in C++ Tutorial
# Detailed C++ Runtime APIs Tutorial

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

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).
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).

For a high level overview of the ExecuTorch Runtime please see [Runtime Overview](runtime-overview.md), and for more in-depth documentation on
each API please see the [Runtime API Reference](executorch-runtime-api-reference.rst).
Expand Down
1 change: 1 addition & 0 deletions docs/source/runtime-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ However, please note:

For more details about the ExecuTorch runtime, please see:

* [Using ExecuTorch with C++](using-executorch-cpp.md)
* [Detailed Runtime APIs Tutorial](running-a-model-cpp-tutorial.md)
* [Simplified Runtime APIs Tutorial](extension-module.md)
* [Building from Source](using-executorch-building-from-source.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/using-executorch-cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For complete examples of building and running a C++ application using the Module

## Low-Level APIs

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).
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).

## Building with CMake

Expand Down
Loading