Skip to content

update building from source doc to make the backend support guidance clearer #12169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: release/0.7
Choose a base branch
from
Open

update building from source doc to make the backend support guidance clearer #12169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions docs/source/using-executorch-building-from-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Or alternatively, [install conda on your machine](https://conda.io/projects/cond
## Install ExecuTorch pip package from source
```bash
# Install ExecuTorch pip package and its dependencies, as well as
# development tools like CMake.
# development tools like CMake, and backend support for XNNPACK and CoreML.
# If developing on a Mac, make sure to install the Xcode Command Line Tools first.
# Intel-based macOS systems require building PyTorch from source (see below)
./install_executorch.sh
Expand All @@ -79,10 +79,16 @@ Or alternatively, [install conda on your machine](https://conda.io/projects/cond
./install_executorch.sh --use-pt-pinned-commit --minimal
```

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

```bash
# Enable the MPS backend
CMAKE_ARGS="-DEXECUTORCH_BUILD_MPS=ON" ./install_executorch.sh
```

```bash
# Disable the XNNPACK backend
CMAKE_ARGS="-DEXECUTORCH_BUILD_XNNPACK=OFF" ./install_executorch.sh
```

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