-
Notifications
You must be signed in to change notification settings - Fork 680
Update install script and building from source docs #10652
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.
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
Changes from 6 commits
0b3c22f
e5a4e67
b7655f7
695c782
a47238b
ce62ba9
53b16bd
df9c97a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,7 +16,7 @@ Linux (x86_64) | |
- Ubuntu 20.04.6 LTS+ | ||
- RHEL 8+ | ||
|
||
macOS (x86_64/M1/M2) | ||
macOS (x86_64/ARM64) | ||
- Big Sur (11.0)+ | ||
|
||
Windows (x86_64) | ||
|
@@ -56,13 +56,21 @@ Or alternatively, [install conda on your machine](https://conda.io/projects/cond | |
conda create -yn executorch python=3.10.0 && conda activate executorch | ||
``` | ||
|
||
## Install ExecuTorch pip package from Source | ||
## Install ExecuTorch pip package from source | ||
```bash | ||
# Install ExecuTorch pip package and its dependencies, as well as | ||
# development tools like CMake. | ||
# If developing on a Mac, make sure to install the Xcode Command Line Tools first. | ||
# Intel-based macOS systems require building PyTorch, Torchvision, and Torchaudio from source (see below) | ||
./install_executorch.sh | ||
``` | ||
|
||
Use the [`--use-pt-pinned-commit` flag](https://github.com/pytorch/executorch/blob/main/install_executorch.sh) to install Executorch with an existing PyTorch build. | ||
See the [PyTorch instructions](https://github.com/pytorch/pytorch#installation) on how to build PyTorch from source. | ||
|
||
|
||
```bash | ||
./install_executorch.sh --use-pt-pinned-commit | ||
``` | ||
mergennachin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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: | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ ExecuTorch supports both iOS and macOS via Objective-C, Swift, and C++. ExecuTor | |
|
||
## Integration | ||
|
||
The ExecuTorch Runtime for iOS and macOS is distributed as a collection of prebuilt [.xcframework](https://developer.apple.com/documentation/xcode/creating-a-multi-platform-binary-framework-bundle) binary targets. These targets are compatible with both iOS and macOS devices and simulators and are available in both release and debug modes: | ||
The ExecuTorch Runtime for iOS and macOS (ARM64) is distributed as a collection of prebuilt [.xcframework](https://developer.apple.com/documentation/xcode/creating-a-multi-platform-binary-framework-bundle) binary targets. These targets are compatible with both iOS and macOS devices and simulators and are available in both release and debug modes: | ||
|
||
* `executorch` - Main Runtime components | ||
* `backend_coreml` - Core ML backend | ||
|
@@ -114,6 +114,13 @@ python3 -m venv .venv && source .venv/bin/activate && pip install --upgrade pip | |
./backends/apple/coreml/scripts/install_requirements.sh | ||
``` | ||
|
||
- **Intel-based macOS** systems require building PyTorch, Torchvision, and Torchaudio from source: | ||
|
||
- Use the [`--use-pt-pinned-commit --minimal` flags](https://github.com/pytorch/executorch/blob/main/install_executorch.py) to install Executorch with an existing PyTorch build. | ||
See the [PyTorch instructions](https://github.com/pytorch/pytorch#installation) on how to build PyTorch from source. | ||
```bash | ||
./install_executorch.sh --use-pt-pinned-commit --minimal | ||
``` | ||
|
||
5. Install [CMake](https://cmake.org): | ||
|
||
Download the macOS binary distribution from the [CMake website](https://cmake.org/download), open the `.dmg` file, move `CMake.app` to the `/Applications` directory, and then run the following command to install the CMake command-line tools: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/Executorch/ExecuTorch/g