Update install script and building from source docs #10652

keyprocedure · 2025-05-02T05:09:06Z

Summary

Updated install_requirements.sh to improve compatibility with source-built PyTorch and Intel macOS systems.
Added checks to prevent install commands from altering existing PyTorch builds by adding the --no-deps flag.
Removed torchaudio and torchvision dependencies for Intel macOS systems to avoid compatibility issues.

Test plan

Tested executorch installations with source-built PyTorch on:

Intel-macOS with PyTorch 2.7.0, Python 3.12.9
ARM64 macOS with PyTorch 2.8.0a0, Python 3.12.9

Validated by exporting and running the MobileNet V2 image classification model, following the examples on the Getting Started with ExecuTorch page.

cc @larryliu0820 @jathu

pytorch-bot · 2025-05-02T05:09:10Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/10652

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 1 New Failure

As of commit df9c97a with merge base 7b39a0c ():

NEW FAILURE - The following job has failed:

pull / test-moshi-linux / linux-job (gh)
test_exported_decoder_xnnpack

This comment was automatically generated by Dr. CI and updates every 15 minutes.

keyprocedure · 2025-05-02T05:11:53Z

@pytorchbot label "module: build/install"

keyprocedure · 2025-05-10T01:23:20Z

@pytorchbot label "release notes: build"

mergennachin

Thank you @keyprocedure

Overall looks great. Thank you for testing end-to-end. Glad that it works.

Please see inline comments below.

mergennachin · 2025-05-12T18:18:23Z

install_requirements.py

+    ):
+        print(
+            "ERROR: Prebuilt PyTorch wheels are no longer available for Intel-based macOS.\n"
+            "Please build from source by following https://pytorch.org/executorch/0.6/using-executorch-building-from-source.html",


https://pytorch.org/executorch/0.6/ -> change this to https://pytorch.org/executorch/main/

mergennachin · 2025-05-12T18:19:38Z

install_requirements.py

+        print(
+            "ERROR: Prebuilt PyTorch wheels are no longer available for Intel-based macOS.\n"
+            "Please build from source by following https://pytorch.org/executorch/0.6/using-executorch-building-from-source.html",


The print message should appear inside this block.

if use_pytorch_nightly and is_intel_mac:

is_intel_mac_os() is just a getter function that should do any printing.

mergennachin · 2025-05-12T18:21:26Z

install_requirements.py

+        )  # For testing.
+
+        EXAMPLES_REQUIREMENTS = [
+            f"torchaudio==2.6.0.{NIGHTLY_VERSION}",


what about this logic?

f"torchaudio==2.6.0.{NIGHTLY_VERSION}" if use_pytorch_nightly else "torchaudio"

I had removed it for testing and forgot to restore it. Updated the code :)

keyprocedure · 2025-05-19T19:11:55Z

Hi @mergennachin, I’ve made the requested changes — could you please take a look when you get a chance?

pytorch-bot · 2025-05-20T16:24:49Z

To add the ciflow label ciflow/trunk please first approve the workflows that are awaiting approval (scroll to the bottom of this page).

This helps ensure we don't trigger CI on this PR until it is actually authorized to do so. Please ping one of the reviewers if you do not have access to approve and run workflows.

mergennachin · 2025-05-20T16:26:08Z

Thanks @keyprocedure

I just started the full CI tests

pytorch-bot · 2025-05-22T16:03:52Z

To add the ciflow label ciflow/trunk please first approve the workflows that are awaiting approval (scroll to the bottom of this page).

This helps ensure we don't trigger CI on this PR until it is actually authorized to do so. Please ping one of the reviewers if you do not have access to approve and run workflows.

keyprocedure · 2025-05-22T16:17:35Z

@mergennachin
It looks like CI is failing because the --no-deps flag prevents the required modules from being installed. I used it to avoid torch from being upgraded, but that's leading to missing modules

Is the expectation that any torch version should be usable, or only ones compatible with the current dependencies?

If any torch version should be usable, would it make more sense to use a temporary constraints.txt file to pin the torch version instead of the --no-deps flag? That may still lead to breakages, but those conflicts would be clearer during the install process. Otherwise, we could keep the --no-deps flag for Intel-macOS installs only

mergennachin · 2025-05-22T19:57:52Z

@keyprocedure - First of all, thanks for being patient with this PR.

Looking a bit more into it. Why do we need --no-deps in the first place?

Presumably, when you install torch from source manually as first step, it should install a newer version from source. And in the install_requirements.py step, perhaps it won't try to upgrade it. Do you know which package is transitively trying to upgrade it?

keyprocedure · 2025-05-27T21:13:26Z

@mergennachin Sorry for the delay

It looks like the torch version is actually downgraded to fit the dependency requirements. I'm not sure which package is causing the version change, but I recently tried to install executorch with the latest torch build without the no-deps flag and after running ./install_executorch.sh --use-pt-pinned-commit, torch gets downgraded to 2.7.0:

Installing collected packages: zstd, sentencepiece, pytz, antlr4-python3-runtime, xxhash, tzdata, tqdm, tomli, safetensors, regex, python-dateutil, pycryptodomex, pyarrow, propcache, pillow, omegaconf, multidict, lxml, hf-xet, hf-transfer, fsspec, frozenlist, dill, cmake, aiohappyeyeballs, yarl, `torch`, tiktoken, pandas, multiprocess, kagglehub, huggingface_hub, blobfile, aiosignal, torchvision, torchdata, torchaudio, tokenizers, aiohttp, transformers, torchsr, timm, datasets, torchtune
Attempting uninstall: torch
Found existing installation: torch 2.8.0a0+git9a8c42f
Uninstalling torch-2.8.0a0+git9a8c42f:
Successfully uninstalled torch-2.8.0a0+git9a8c42f

keyprocedure · 2025-06-12T18:56:20Z

If the downgrade is being caused by something that I'm doing incorrectly during the install process/isolated to my build, I can remove the no-deps flag from the pip install command for this PR. I'm open to any suggestions/guidance.

mergennachin · 2025-06-13T22:02:08Z

Hi @keyprocedure

I did some digging and found out that torchvision and torchaudio were in fact downgrading.

torch, torchvision and torchaudio are in lock step dependency.

I did some refactoring in (#11653). torchvision and torchaudio are not absolute necessity. Only used for examples.

Once that PR is landed, we can update the Intel instruction to be as follows:

Build torch from source
./install_executorch.sh --use-pt-pinned-commit --minimal

keyprocedure · 2025-06-13T22:28:41Z

Hey @mergennachin, I really appreciate your follow up!

Perfect, that'll simplify things.
I'll update the Intel instructions in this PR once #11653 lands.

mergennachin · 2025-06-16T16:55:26Z

Hi @keyprocedure

I just landed the PR, please rebase. Hopefully it will simplify a lot of things in this PR

…ons built from source

… update docs url

keyprocedure · 2025-06-17T15:30:43Z

@mergennachin I've rebased and updated the Intel macOS install instructions to ./install_executorch.sh --use-pt-pinned-commit --minimal. Feel free to let me know if there's anything else that needs to be changed.

mergennachin

See inline

mergennachin · 2025-06-17T17:20:05Z

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

+  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.
+


Use relative paths

I updated the flag links to use relative paths to the .py file.
For the PyTorch instructions link, since it points to a doc in the PyTorch repo, is there a way to reference that using a relative path, or should we keep the current path?

mergennachin · 2025-06-17T17:21:30Z

docs/source/using-executorch-ios.md

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


Let's not have two instructions. Let's consolidate Intel based instructions in "building from source section" and call it a day

Good point, moved the instructions.

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

mergennachin · 2025-06-17T17:23:47Z

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

   ./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.  


s/Executorch/ExecuTorch/g

keyprocedure · 2025-06-17T23:23:21Z

I removed the mention of building Torchvision and Torchaudio from source in the building-from-source doc for Intel-macOS builds to simplify the instructions, since they're not required to install ExecuTorch.

mergennachin

Thank you @keyprocedure

keyprocedure · 2025-06-20T19:10:41Z

Happy to help!

@larryliu0820

### Summary - Updated `install_requirements.sh` to improve compatibility with source-built PyTorch and Intel macOS systems. - Added checks to prevent install commands from altering existing PyTorch builds by adding the `--no-deps` flag. - Removed `torchaudio` and `torchvision` dependencies for Intel macOS systems to avoid compatibility issues. Fixes pytorch#9772 ### Test plan Tested executorch installations with source-built PyTorch on: - Intel-macOS with PyTorch 2.7.0, Python 3.12.9 - ARM64 macOS with PyTorch 2.8.0a0, Python 3.12.9 Validated by exporting and running the MobileNet V2 image classification model, following the examples on the [Getting Started with ExecuTorch](https://pytorch.org/executorch/stable/getting-started.html) page. cc @larryliu0820 @jathu

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 2, 2025

pytorch-bot bot added the module: build/install Issues related to the cmake and buck2 builds, and to installing ExecuTorch label May 2, 2025

keyprocedure marked this pull request as ready for review May 10, 2025 01:15

keyprocedure requested a review from mergennachin as a code owner May 10, 2025 01:15

pytorch-bot bot added the release notes: build Changes related to build, including dependency upgrades, build flags, optimizations, etc. label May 10, 2025

mergennachin requested review from jathu, larryliu0820 and GregoryComer May 12, 2025 18:23

mergennachin requested changes May 12, 2025

View reviewed changes

mergennachin added the ciflow/trunk label May 14, 2025

pytorch-bot bot removed the ciflow/trunk label May 15, 2025

mergennachin added the ciflow/trunk label May 20, 2025

pytorch-bot bot removed the ciflow/trunk label May 20, 2025

mergennachin added the ciflow/trunk label May 20, 2025

pytorch-bot bot removed the ciflow/trunk label May 22, 2025

mergennachin added the ciflow/trunk label May 22, 2025

pytorch-bot bot removed the ciflow/trunk label May 22, 2025

mergennachin mentioned this pull request Jun 13, 2025

Install examples and domain libraries as last (optional) step #11653

Merged

keyprocedure added 5 commits June 16, 2025 18:17

Update docs for intel-macOS systems and building from source

0b3c22f

Add intel-macOS system check

e5a4e67

Update pip install commands for intel macOS systems and pytorch versi…

b7655f7

…ons built from source

Update building from source docs

695c782

Restore fallback installs for audio and vision; move print statement;…

a47238b

… update docs url

keyprocedure force-pushed the update-compile-from-source-docs branch from 9158045 to a47238b Compare June 17, 2025 01:58

Update Intel macOS install instructions in doc

ce62ba9

mergennachin reviewed Jun 17, 2025

View reviewed changes

keyprocedure added 2 commits June 17, 2025 15:58

Consolidate Intel-macOS instructions into building-from-source

53b16bd

Remove Torchvision and Torchaudio references in Intel instructions

df9c97a

mergennachin approved these changes Jun 20, 2025

View reviewed changes

mergennachin merged commit 9345972 into pytorch:main Jun 20, 2025
95 of 96 checks passed

		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.

Update install script and building from source docs #10652

Update install script and building from source docs #10652

Uh oh!

Conversation

keyprocedure commented May 2, 2025 • edited by pytorch-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

pytorch-bot bot commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/10652

❌ 1 New Failure

Uh oh!

keyprocedure commented May 2, 2025

Uh oh!

keyprocedure commented May 10, 2025

Uh oh!

mergennachin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keyprocedure commented May 19, 2025

Uh oh!

pytorch-bot bot commented May 20, 2025

Uh oh!

mergennachin commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented May 22, 2025

Uh oh!

keyprocedure commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergennachin commented May 22, 2025

Uh oh!

keyprocedure commented May 27, 2025

Uh oh!

keyprocedure commented Jun 12, 2025

Uh oh!

mergennachin commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

keyprocedure commented Jun 13, 2025

Uh oh!

mergennachin commented Jun 16, 2025

Uh oh!

keyprocedure commented Jun 17, 2025

Uh oh!

mergennachin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keyprocedure commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergennachin left a comment

Choose a reason for hiding this comment

Uh oh!

keyprocedure commented Jun 20, 2025

Uh oh!

Uh oh!

keyprocedure commented May 2, 2025 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented May 2, 2025 •

edited

Loading

mergennachin commented May 20, 2025 •

edited

Loading

keyprocedure commented May 22, 2025 •

edited

Loading

mergennachin commented Jun 13, 2025 •

edited

Loading

keyprocedure commented Jun 17, 2025 •

edited

Loading