Skip to content

Commit 0b3c22f

Browse files
committed
Update docs for intel-macOS systems and building from source
1 parent 7b39a0c commit 0b3c22f

File tree

5 files changed

+23
-7
lines changed

5 files changed

+23
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It supports a wide range of models including LLMs (Large Language Models), CV (C
1919
Platform Support:
2020
- Operating Systems:
2121
- iOS
22-
- Mac
22+
- MacOS (ARM64)
2323
- Android
2424
- Linux
2525
- Microcontrollers

docs/source/backends-xnnpack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The XNNPACK delegate is the ExecuTorch solution for CPU execution on mobile CPUs
1414
- ARM64 on Android, iOS, macOS, Linux, and Windows.
1515
- ARMv7 (with NEON) on Android.
1616
- ARMv6 (with VFPv2) on Linux.
17-
- x86 and x86-64 (up to AVX512) on Windows, Linux, macOS, Android, and iOS simulator.
17+
- x86 and x86-64 (up to AVX512) on Windows, Linux, Android.
1818

1919
## Development Requirements
2020

docs/source/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ The following are required to install the ExecuTorch host libraries, needed to e
1010

1111
- Python 3.10 - 3.12
1212
- g++ version 7 or higher, clang++ version 5 or higher, or another C++17-compatible toolchain.
13-
- Linux or MacOS operating system (Arm or x86).
14-
- Windows is supported via WSL.
13+
- Linux (x86_64 or ARM64) or macOS (ARM64).
14+
- Intel-based macOS systems require building PyTorch from source (see [Building From Source](using-executorch-building-from-source.md) for instructions).
15+
- Windows is supported via WSL.
1516

1617
## Installation
1718
To use ExecuTorch, you will need to install both the Python package and the appropriate platform-specific runtime libraries. Pip is the recommended way to install the ExecuTorch python package.

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Linux (x86_64)
1616
- Ubuntu 20.04.6 LTS+
1717
- RHEL 8+
1818

19-
macOS (x86_64/M1/M2)
19+
macOS (x86_64/ARM64)
2020
- Big Sur (11.0)+
2121

2222
Windows (x86_64)
@@ -56,13 +56,21 @@ Or alternatively, [install conda on your machine](https://conda.io/projects/cond
5656
conda create -yn executorch python=3.10.0 && conda activate executorch
5757
```
5858

59-
## Install ExecuTorch pip package from Source
59+
## Install ExecuTorch pip package from source
6060
```bash
6161
# Install ExecuTorch pip package and its dependencies, as well as
6262
# development tools like CMake.
6363
# If developing on a Mac, make sure to install the Xcode Command Line Tools first.
64+
# Intel-based macOS systems require building PyTorch from source (see below)
6465
./install_executorch.sh
6566
```
67+
68+
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.
69+
See the [PyTorch instructions](https://github.com/pytorch/pytorch#installation) on how to build PyTorch from source.
70+
71+
```bash
72+
./install_executorch.sh --use-pt-pinned-commit
73+
```
6674

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

docs/source/using-executorch-ios.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ExecuTorch supports both iOS and macOS via Objective-C, Swift, and C++. ExecuTor
44

55
## Integration
66

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

99
* `executorch` - Main Runtime components
1010
* `backend_coreml` - Core ML backend
@@ -114,6 +114,13 @@ python3 -m venv .venv && source .venv/bin/activate && pip install --upgrade pip
114114
./backends/apple/coreml/scripts/install_requirements.sh
115115
```
116116

117+
- **Intel-based macOS** systems require building PyTorch from source:
118+
- Use the [`--use-pt-pinned-commit` flag](https://github.com/pytorch/executorch/blob/main/install_requirements.sh) to install Executorch with an existing PyTorch build.
119+
See the [PyTorch instructions](https://github.com/pytorch/pytorch#installation) on how to build PyTorch from source.
120+
```bash
121+
./install_requirements.sh --use-pt-pinned-commit
122+
```
123+
117124
5. Install [CMake](https://cmake.org):
118125

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

0 commit comments

Comments
 (0)