Skip to content

Commit 22b9e59

Browse files
authored
update building from source doc to make the backend support guidance clearer
Differential Revision: D77609951 Pull Request resolved: #12140
1 parent 9554826 commit 22b9e59

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/source/using-executorch-building-from-source.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Or alternatively, [install conda on your machine](https://conda.io/projects/cond
6060
## Install ExecuTorch pip package from source
6161
```bash
6262
# Install ExecuTorch pip package and its dependencies, as well as
63-
# development tools like CMake.
63+
# development tools like CMake, and backend support for XNNPACK and CoreML.
6464
# If developing on a Mac, make sure to install the Xcode Command Line Tools first.
6565
# Intel-based macOS systems require building PyTorch from source (see below)
6666
./install_executorch.sh
@@ -79,10 +79,16 @@ Or alternatively, [install conda on your machine](https://conda.io/projects/cond
7979
./install_executorch.sh --use-pt-pinned-commit --minimal
8080
```
8181

82-
Not all backends are built into the pip wheel by default. You can link these missing/experimental backends by turning on the corresponding cmake flag. For example, to include the MPS backend:
82+
Notice that only XNNPACK and CoreML backends are supported by default. You can enable additional backends or disable default backends by setting the corresponding CMake flags:
8383

8484
```bash
85+
# Enable the MPS backend
8586
CMAKE_ARGS="-DEXECUTORCH_BUILD_MPS=ON" ./install_executorch.sh
87+
```
88+
89+
```bash
90+
# Disable the XNNPACK backend
91+
CMAKE_ARGS="-DEXECUTORCH_BUILD_XNNPACK=OFF" ./install_executorch.sh
8692
```
8793

8894
For development mode, run the command with `--editable`, which allows us to modify Python source code and see changes reflected immediately.

0 commit comments

Comments
 (0)