You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Remove submodule update commands
To make the getting started page simpler. These commands will be run in ./install_executorch.sh so we don't have to ask the users to run it.
* Update using-executorch-building-from-source.md
Copy file name to clipboardExpand all lines: docs/source/using-executorch-building-from-source.md
+12-18
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ portability details.
45
45
conda activate executorch
46
46
```
47
47
48
-
### Clone and install ExecuTorch requirements
48
+
### Clone ExecuTorch
49
49
50
50
```bash
51
51
# Clone the ExecuTorch repo from GitHub
@@ -57,14 +57,17 @@ portability details.
57
57
# Update and pull submodules
58
58
git submodule sync
59
59
git submodule update --init
60
+
```
60
61
62
+
## Install ExecuTorch pip package from Source
63
+
```bash
61
64
# Install ExecuTorch pip package and its dependencies, as well as
62
65
# development tools like CMake.
63
66
# If developing on a Mac, make sure to install the Xcode Command Line Tools first.
64
67
./install_executorch.sh
65
68
```
66
69
67
-
Use the [`--pybind` flag](https://github.com/pytorch/executorch/blob/main/install_executorch.sh#L26-L29) to install with pybindings and dependencies for other backends.
70
+
Use the [`--pybind` flag](https://github.com/pytorch/executorch/blob/main/install_executorch.sh#L26-L29) to install with pybindings and dependencies for other backends.
ExecuTorch's CMake build system covers the pieces of the runtime that are
111
114
likely to be useful to embedded systems users.
@@ -125,17 +128,8 @@ likely to be useful to embedded systems users.
125
128
`libportable_kernels.a`, so the program may use any of the operators it
126
129
implements.
127
130
128
-
## One-time setup to prepare for CMake Build
129
-
130
-
Follow the steps below to have the tools ready before using CMake to build on your machine.
131
-
132
-
1. If your system's version of python3 is older than 3.11:
133
-
- Run `pip install tomli`
134
-
3. Install CMake version 3.19 or later:
135
-
- Run `conda install cmake` or `pip install cmake`.
136
-
137
131
138
-
## Configure the CMake Build
132
+
### Configure the CMake build
139
133
140
134
Follow these steps after cloning or pulling the upstream repo, since the build
141
135
dependencies may have changed.
@@ -152,7 +146,7 @@ cd executorch
152
146
153
147
Once this is done, you don't need to do it again until you pull from the upstream repo again, or if you modify any CMake-related files.
154
148
155
-
### CMake Build Options
149
+
### CMake build options
156
150
157
151
The release build offers optimizations intended to improve performance and reduce binary size. It disables program verification and executorch logging, and adds optimizations flags.
158
152
```bash
@@ -167,7 +161,7 @@ To further optimize the release build for size, use both:
167
161
168
162
See [CMakeLists.txt](https://github.com/pytorch/executorch/blob/main/CMakeLists.txt)
169
163
170
-
## Build the runtime components
164
+
### Build the runtime components
171
165
172
166
Build all targets with
173
167
@@ -184,7 +178,7 @@ cd executorch
184
178
cmake --build cmake-out -j9
185
179
```
186
180
187
-
## Use an example app`executor_runner` to execute a .pte file
181
+
## Use an example binary`executor_runner` to execute a .pte file
188
182
189
183
First, generate an `add.pte` or other ExecuTorch program file using the
190
184
instructions as described in
@@ -196,7 +190,7 @@ Then, pass it to the command line tool:
0 commit comments