Skip to content

Commit a6d26d7

Browse files
committed
Update on "[executorch][docs] runtime-overview.md"
First draft of a high-level document describing the runtime. Differential Revision: [D49852127](https://our.internmc.facebook.com/intern/diff/D49852127/) [ghstack-poisoned]
2 parents e5952b2 + c209474 commit a6d26d7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/source/runtime-overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Runtime Overview
1+
# ExecuTorch Runtime Overview
22

33
This document discusses the design of the ExecuTorch runtime, which executes
44
ExecuTorch program files on edge devices like smartphones, wearables, and
@@ -81,7 +81,7 @@ semantics whenever possible.
8181
[`aten_bridge`](https://github.com/pytorch/executorch/blob/main/extension/aten_util/aten_bridge.h)
8282
to convert between the two. This can be helpful for projects that already use
8383
PyTorch C++ types.
84-
* The semantics of operators like "aten::add" and "aten::sigmoid" are identical
84+
* The semantics of operators like `aten::add` and `aten::sigmoid` are identical
8585
between ExecuTorch and core PyTorch. ExecuTorch provides a testing framework
8686
to ensure this, and to help test future implementations of these operators.
8787

@@ -95,7 +95,7 @@ can build it for a wide variety of target systems.
9595
* The code is C++11-compatible to work with older toolchains.
9696
* The runtime does not use exceptions or RTTI, although it is not antagonistic
9797
to them.
98-
* The code is compatible with gcc and clang, and has also been built with
98+
* The code is compatible with GCC and Clang, and has also been built with
9999
several proprietary embedded toolchains.
100100
* The repo provides both CMake and buck2 build systems to make integration
101101
easier.
@@ -113,11 +113,11 @@ Applications can control all memory allocation through the `MemoryManager`,
113113
runtime makes no direct calls to `malloc()` or `new`, or to types like
114114
`std::vector` that allocate under the hood. This makes it possible to:
115115

116-
* run in environments without a heap, but still use the heap if desired.
117-
* avoid synchronization on the heap during model load and execution.
118-
* control which memory region to use for different types of data. For example,
116+
* Run in environments without a heap, but still use the heap if desired.
117+
* Avoid synchronization on the heap during model load and execution.
118+
* Control which memory region to use for different types of data. For example,
119119
one set of mutable tensors could live in SRAM while another set lived in DRAM.
120-
* easily monitor how much memory the runtime uses.
120+
* Easily monitor how much memory the runtime uses.
121121

122122
However, please note that specific kernel or backend implementations may use
123123
arbitrary runtime or operating system features. Users should double-check the

0 commit comments

Comments
 (0)