Skip to content

Commit b541a48

Browse files
mergennachinfacebook-github-bot
authored andcommitted
Replace Executorch with ExecuTorch (#455)
Summary: Pull Request resolved: #455 Start with md files first. codemod -m -d ./ --extensions md 'Executorch' 'ExecuTorch' Went one-by-one to make sure it is only changing texts (not code examples). Reviewed By: dbort Differential Revision: D49550644 fbshipit-source-id: 1bc3eb8670eb90ecf1ebee083415ae6c2524a87a
1 parent 2f24502 commit b541a48

File tree

14 files changed

+36
-36
lines changed

14 files changed

+36
-36
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ must work with threading**
113113
## For Delegate Authors
114114

115115
* Use [this](/docs/website/docs/contributors/delegates.md)
116-
guide when integrating your delegate with Executorch.
116+
guide when integrating your delegate with ExecuTorch.
117117

118118
* Refer to [this](/docs/website/docs/contributors/delegates_and_dependencies.md)
119119
set of guidelines when including a 3p depenency for your delegate.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Compared to the legacy Lite Interpreter, there are some major benefits:
3939

4040
- [Setting up ExecuTorch from GitHub](/docs/website/docs/tutorials/00_setting_up_executorch.md)
4141
- (Optional) [Building with CMake](/docs/website/docs/tutorials/cmake_build_system.md)
42-
- [Exporting to Executorch](/docs/website/docs/tutorials/exporting_to_executorch.md)
42+
- [Exporting to ExecuTorch](/docs/website/docs/tutorials/exporting_to_executorch.md)
4343
- [EXIR Spec](/docs/website/docs/ir_spec/00_exir.md)
4444
- [Exporting manual](/docs/website/docs/export/00_export_manual.md)
4545
- [Quantization](/docs/website/docs/tutorials/quantization_flow.md)
4646
- [Delegate to a backend](/docs/website/docs/tutorials/backend_delegate.md)
4747
- [Profiling](/docs/website/docs/tutorials/profiling.md)
48-
- [Executorch Google Colab](https://colab.research.google.com/drive/1m8iU4y7CRVelnnolK3ThS2l2gBo7QnAP#scrollTo=1o2t3LlYJQY5)
48+
- [ExecuTorch Google Colab](https://colab.research.google.com/drive/1m8iU4y7CRVelnnolK3ThS2l2gBo7QnAP#scrollTo=1o2t3LlYJQY5)
4949

5050
## Directory Structure [WIP]
5151

@@ -67,7 +67,7 @@ executorch
6767
| ├── backend # Backend delegate ahead of time APIs
6868
| ├── capture # Program capture.
6969
| ├── dialects # Op sets for various dialects in the export process.
70-
| ├── emit # Conversion from ExportedProgram to Executorch execution instructions.
70+
| ├── emit # Conversion from ExportedProgram to ExecuTorch execution instructions.
7171
| ├── program # Export artifacts.
7272
| ├── serialize # Serialize final export artifact.
7373
├── extension # Extensions built on top of the runtime.
@@ -90,7 +90,7 @@ executorch
9090
| ├── executor # Model loading, initalization, and execution.
9191
| ├── kernel # Kernel registration and management.
9292
| ├── platform # Layer between architecture specific code and user calls.
93-
├── schema # Executorch program definition, TODO move under serialization/
93+
├── schema # ExecuTorch program definition, TODO move under serialization/
9494
├── scripts # Utility scripts for size management, dependency management, etc.
9595
├── sdk # Model profiling, debugging, and introspection: NOT READY YET FOR OSS USE
9696
├── shim # Compatibility layer between OSS and Internal builds

backends/arm/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Executorch Arm/TOSA Delegate
1+
# ExecuTorch Arm/TOSA Delegate
22

3-
This subtree contains the Arm Delegate implementation for Executorch.
3+
This subtree contains the Arm Delegate implementation for ExecuTorch.
44

55
This delegate is structured to, over time, support a number of different Arm devices
66
through an AoT flow which targets multiple Arm IP using the TOSA standard.

backends/xnnpack/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Executorch XNNPACK Delegate
1+
# ExecuTorch XNNPACK Delegate
22

3-
This subtree contains the XNNPACK Delegate implementation for Executorch.
3+
This subtree contains the XNNPACK Delegate implementation for ExecuTorch.
44
XNNPACK is an optimized library of neural network inference operators for ARM
55
and x86 CPUs. It is an open source project used by PyTorch. The delegate is the
66
mechanism for leveraging the XNNPACK library to accelerate operators running on

docs/source/compiler-delegate-and-partitioner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ with open(save_path, "wb") as f:
251251

252252
## Runtime
253253

254-
The serialized flatbuffer model is loaded by the Executorch runtime. The
254+
The serialized flatbuffer model is loaded by the ExecuTorch runtime. The
255255
preprocessed blob is directly stored in the flatbuffer, which is loaded into a
256256
call to the backend's `init()` function during model initialization stage. At
257257
the model execution stage, the initialized handled can be executed through the

docs/website/docs/basics/terminology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ along with related types (ScalarType, etc.)
1212
clients: e.g., CUDA support, sparse tensor support, dtype promotion
1313

1414
### Portable mode
15-
Portable mode uses Executorch's smaller `torch::executor::Tensor` (aka ETensor)
15+
Portable mode uses ExecuTorch's smaller `torch::executor::Tensor` (aka ETensor)
1616
implementation, along with related types (`torch::executor::ScalarType`, etc.)
1717
* ETensor's API is a source-compatible subset of `at::Tensor`. Code that is
1818
written against ETensor can also build against `at::Tensor`.

docs/website/docs/contributors/delegates.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# How to integrate a Backend Delegate with Executorch?
1+
# How to integrate a Backend Delegate with ExecuTorch?
22

33
Disclaimer: We are planning to restructure the repository around delegates.
44
With that some of these guidelines will change in the future.
55

6-
This is a high level guideline when integrating a backend delegate with Executorch.
6+
This is a high level guideline when integrating a backend delegate with ExecuTorch.
77

88
## Directory Structure
99

@@ -13,9 +13,9 @@ Delegate files should be under this directory:
1313
## Python files
1414

1515
Delegate Python files such as one implementing `preprocess()` or `partition()`
16-
functions for Executorch AoT flow, excluding any external third-party
16+
functions for ExecuTorch AoT flow, excluding any external third-party
1717
dependencies and their files, should be installed and available with
18-
the top level Executorch package. For third-party dependencies, please refer to
18+
the top level ExecuTorch package. For third-party dependencies, please refer to
1919
[this](./delegates_and_dependencies.md).
2020

2121
## C++ sources
@@ -25,13 +25,13 @@ sources.
2525

2626
For the CMake setup, the delegate dir should be included by the
2727
top level `CMakeLists.txt` file using `add_subdirectory` CMake command, and
28-
should be built conditionally with an Executorch build flag like
28+
should be built conditionally with an ExecuTorch build flag like
2929
`EXECUTORCH_BUILD_<DELEGATE_NAME>`, see `EXECUTORCH_BUILD_XNNPACK` for example.
3030
For third-party dependencies, please refer to
3131
[this](./delegates_and_dependencies.md).
3232

3333
Adding buck2 support should make the delegate available to more
34-
Executorch users.
34+
ExecuTorch users.
3535

3636
* More details TBD
3737

docs/website/docs/contributors/delegates_and_dependencies.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Python or C++ dependency. This guide will talk about only Python AoT dependencie
2121

2222
**Guidelines:**
2323

24-
* If Executorch already includes a dependency you require, prefer
24+
* If ExecuTorch already includes a dependency you require, prefer
2525
to use that if possible.
2626
* Since the dependency is only used by the files inside the
2727
`executorch/backends/<delegate_name>/` - it should introduced in
2828
a way that it is needed only by the code inside the backend delegate
2929
directory.
3030
* The dependency should not be installed by default when installing
31-
the Executorch Python package.
31+
the ExecuTorch Python package.
3232

3333
More details in the section [below](#python-dependencies).
3434

@@ -49,7 +49,7 @@ for these third-party dependencies.
4949
* If a delegate has a dependency which is already part of
5050
`executorch/third-party` then try to use that if possible. This
5151
helps with reducing the binary size when the delegate is enabled.
52-
* Rest of the Executorch code, outside of the delegate, should not depend on
52+
* Rest of the ExecuTorch code, outside of the delegate, should not depend on
5353
this. And it should should build and run correctly without this dependency
5454
when the delegate is disabled at build time.
5555

@@ -64,9 +64,9 @@ the test.
6464
**Guidelines:**
6565

6666
* For a Python dependency, it should not be installed by default when
67-
installing the Executorch Python package.
67+
installing the ExecuTorch Python package.
6868
* If for C++ tests, it should not be part of the
69-
Executorch runtime even when the delegate is built/enabled.
69+
ExecuTorch runtime even when the delegate is built/enabled.
7070

7171
## Other considerations
7272

@@ -104,10 +104,10 @@ Python packaging is complicated and continuously evolving. For delegate
104104
dependencies, we recommend that a delegate specifies its third-party
105105
dependencies under `executorch/backends/<delegate_name>/requirements.txt` to be
106106
supplied to pip at installation time. The goal is to decouple them from the core
107-
Executorch dependencies.
107+
ExecuTorch dependencies.
108108

109109
Version conflict should be avoided by trying to use the already included
110-
dependency by Executorch or by some other backend if possible. Otherwise
110+
dependency by ExecuTorch or by some other backend if possible. Otherwise
111111
try some other
112112
[recommended](https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts)
113113
ways to mitigate version conflicts.
@@ -128,7 +128,7 @@ dependency in the `executorch/backends/<delegate_name>/third-party`.
128128

129129
### buck2/CMake support
130130
At a minimum CMake support is required. Adding buck2 support should make
131-
the delegate available to more Executorch users.
131+
the delegate available to more ExecuTorch users.
132132

133133
* More details TBD
134134

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Design Docs
22

3-
Executorch stack diagram: https://docs.google.com/drawings/d/1bBIbG6YDIjdx8emS_6K23YM6WyRkKVpPt-26nznxroU/edit
3+
ExecuTorch stack diagram: https://docs.google.com/drawings/d/1bBIbG6YDIjdx8emS_6K23YM6WyRkKVpPt-26nznxroU/edit
44

55
High-level design doc: https://docs.google.com/document/d/1Z12w6-KtwoFDh781LQAbfwUdEZw9cwTCmz5BmKuS6U8/edit#

docs/website/docs/contributors/portable_programming.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ NOTE: This document covers the runtime code: i.e., the code that needs to build
44
for and execute in target hardware environments. These rules do not necessarily
55
apply to code that only runs on the development host, like authoring tools.
66

7-
The Executorch runtime code is intendend to be portable, and should build for a
7+
The ExecuTorch runtime code is intendend to be portable, and should build for a
88
wide variety of systems, from servers to mobile phones to DSPs, from POSIX to
99
Windows to bare-metal environments.
1010

@@ -35,7 +35,7 @@ dependencies except:
3535

3636
## Platform Abstraction Layer (PAL)
3737

38-
To avoid assuming the capabilities of the target system, the Executorch runtime
38+
To avoid assuming the capabilities of the target system, the ExecuTorch runtime
3939
lets clients override low-level functions in its Platform Abstraction Layer
4040
(PAL), defined in `//executorch/runtime/platform/platform.h`, to perform operations
4141
like:
@@ -56,7 +56,7 @@ the data already loaded.
5656

5757
## Integer Types
5858

59-
Executorch runtime code should not assume anything about the sizes of primitive
59+
ExecuTorch runtime code should not assume anything about the sizes of primitive
6060
types like `int`, `short`, or `char`. For example, the C++ standard only
6161
guarantees that `int` will be at least 16 bits wide. And ARM toolchains treat
6262
`char` as unsigned, while other toolchains often treat it as signed.
@@ -88,7 +88,7 @@ without floating point support.
8888
## Logging
8989

9090
Instead of using `printf()`, `fprintf()`, `cout`, `cerr`, or a library like
91-
`folly::logging` or `glog`, the Executorch runtime provides the `ET_LOG`
91+
`folly::logging` or `glog`, the ExecuTorch runtime provides the `ET_LOG`
9292
interface in `//executorch/runtime/platform/log.h` and the `ET_CHECK` interface in
9393
`//executorch/runtime/platform/assert.h`. The messages are printed using a hook in the PAL,
9494
which means that clients can redirect them to any underlying logging system, or

docs/website/docs/contributors/program_file_format.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Program file format
22

3-
Executorch programs are serialized as modified binary flatbuffer files.
3+
ExecuTorch programs are serialized as modified binary flatbuffer files.
44

55
```
66
┌───────────────────────────────────┐
77
│Standard flatbuffer header │
88
├───────────────────────────────────┤
9-
│Optional Executorch extended header│
9+
│Optional ExecuTorch extended header│
1010
├───────────────────────────────────┤
1111
│Flatbuffer-serialized program data │
1212
│ │
@@ -39,7 +39,7 @@ Program files may have an optional extended header at byte offset 8, recognized
3939
by the magic string beginning with `eh` and followed by two ASCII decimal
4040
digits. This header includes the size of the flatbuffer-encoded core program
4141
data, and the starting offset of the segments that may follow the program data.
42-
Note that this header is Executorch-specific, but even when present it does not
42+
Note that this header is ExecuTorch-specific, but even when present it does not
4343
upset most flatbuffer-parsing code (apart from the rarely-used
4444
`GetBufferStartFromRootPointer()`).
4545

docs/website/docs/ir_spec/00_exir.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ Other permutations of NCHW are allowed but we don’t have explicit names for th
602602

603603
See more on channel_last mem format: [https://pytorch.org/tutorials/intermediate/memory_format_tutorial.html](https://pytorch.org/tutorials/intermediate/memory_format_tutorial.html)
604604

605-
For Executorch, we have introduced a concept of dim orders to convey how a dense tensor is laid out in memory. Tensor's memory layout and memory format representation using the dim order in the Executorch the stack is still a WIP. We will update this doc and the IR spec very shortly.
605+
For ExecuTorch, we have introduced a concept of dim orders to convey how a dense tensor is laid out in memory. Tensor's memory layout and memory format representation using the dim order in the ExecuTorch the stack is still a WIP. We will update this doc and the IR spec very shortly.
606606

607607
### Tensor
608608
A Tensor type describes a mathematical tensor.

docs/website/docs/ir_spec/02_edge_dialect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Default value is true. If set to false, graph validaity check will be turned off
4444

4545
## Edge Operator
4646

47-
As mentioned before, an edge operator is an ATen core operator with type specialization. This means the instance of edge operator contains a set of dtype constraints, to describe all the tensor dtypes supported by both Executorch runtime and their ATen kernels. These dtype constraints are expressed in a DSL defined in [edge.yaml](https://github.com/pytorch/executorch/blob/main/exir/dialects/edge/edge.yaml). Here's an example of the dtype constraints:
47+
As mentioned before, an edge operator is an ATen core operator with type specialization. This means the instance of edge operator contains a set of dtype constraints, to describe all the tensor dtypes supported by both ExecuTorch runtime and their ATen kernels. These dtype constraints are expressed in a DSL defined in [edge.yaml](https://github.com/pytorch/executorch/blob/main/exir/dialects/edge/edge.yaml). Here's an example of the dtype constraints:
4848

4949
```
5050
- func: sigmoid

docs/website/docs/sdk/05_ETDB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Debugging with ETDB
22

3-
ETDB (Executorch Debugger) is an interactive text-based tool used for investigating models (`ETRecord`) and profiling information (`ETDump`). Features provided include:
3+
ETDB (ExecuTorch Debugger) is an interactive text-based tool used for investigating models (`ETRecord`) and profiling information (`ETDump`). Features provided include:
44
- **Tabular Visualization** of model graphs
55
- **Drill-in Selection** of components for detailed investigation
66
- **Aggregated Operator Statistics** based on results from ETDump

0 commit comments

Comments
 (0)