Remove usage of environment variables in wheel building - #9583

Merged
jathu merged 5 commits into
mainfrom
jathu/use-cmake-args
Mar 25, 2025
Merged

Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom
jathu/use-cmake-args

Conversation

@jathu

@jathujathu commented Mar 25, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.

Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).

Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:

executorch/.ci/scripts/wheel/envvar_base.sh

Line 20 in 644b7dd

CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"

executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15 in 644b7dd

CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"

Test plan

build + check CMakeCache.txt to ensure flags are set

# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off

cc @larryliu0820@lucylq

@jathujathu added module: build/install Issues related to the cmake and buck2 builds, and to installing ExecuTorch ciflow/trunk labels Mar 25, 2025
@pytorch-bot

pytorch-botBot commented Mar 25, 2025•
edited
Loading

Copy link
Copy Markdown

🔗 Helpful Links

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

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

❌ 2 New Failures, 2 Pending, 2 Unrelated Failures

As of commit 69a5ba4 with merge base 7248b19 (image):

NEW FAILURES - The following jobs have failed:

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

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

@facebook-github-botfacebook-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 Mar 25, 2025
@jathu
jathuforce-pushed the jathu/use-cmake-args branch 3 times, most recently from d1a3972 to 578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed the jathu/use-cmake-args branch from 578e720 to 4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed the jathu/use-cmake-args branch from 4c96f33 to 93f6112CompareMarch 25, 2025 17:54
@jathu
jathu marked this pull request as ready for review March 25, 2025 17:55
larryliu0820
larryliu0820 reviewed Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py Outdated
swolchok
swolchok reviewed Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin requested changes Mar 25, 2025
View reviewed changes

@mergennachinmergennachin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment

@jathu
jathuforce-pushed the jathu/use-cmake-args branch from 6949e35 to 5501b06CompareMarch 25, 2025 18:39
@jathu
jathu requested a review from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed the jathu/use-cmake-args branch from b989433 to 36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed the jathu/use-cmake-args branch from 63c33b8 to a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed the jathu/use-cmake-args branch from a5e6fcf to 69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu merged commit be3c1ec into mainMar 25, 2025
@jathu
jathu deleted the jathu/use-cmake-args branch March 25, 2025 22:10
@jathujathu mentioned this pull request Mar 31, 2025
Merged
jathu added a commit that referenced this pull request Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit that referenced this pull request Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit that referenced this pull request Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes
+1 more reviewer
@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Remove usage of environment variables in wheel building - #9583
Merged
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Mar 25, 2025
Merged
Remove usage of environment variables in wheel building#9583
jathu merged 5 commits into
mainfrom 
jathu/use-cmake-args
Conversation
@jathu
@jathujathu
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Summary
We seem to be using a combination of CMAKE_ARGS and environment variables when creating wheels. Ultimately, CMake only uses the cmake args, however we redefine some of these flags as env vars to help setup.py determine if a certain feature is turned on. Specifically, it looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single source of truth. For more details and other considerations, see #9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of environment variables to control features:
executorch/.ci/scripts/wheel/envvar_base.sh

Line 20
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
executorch/.ci/scripts/wheel/envvar_macos.sh

Lines 14 to 15
in
644b7dd
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"
 CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_MPS=ON"
Test plan
build + check CMakeCache.txt to ensure flags are set
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
cc @larryliu0820@lucylq
@jathujathu
added

module: build/install
Issues related to the cmake and buck2 builds, and to installing ExecuTorch
ciflow/trunk

labels
Mar 25, 2025
@pytorch-bot
pytorch-botBot
commented
Mar 25, 2025•

edited

Loading

Copy link


Copy Markdown

🔗 Helpful Links
🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9583
Note: Links to docs will display an error until the docs builds have been completed.
❌ 2 New Failures, 2 Pending, 2 Unrelated Failures
As of commit 69a5ba4 with merge base 7248b19 (image):
NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:
👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes.
@facebook-github-botfacebook-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
Mar 25, 2025
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
3 times, most recently
from
d1a3972 to
578e720CompareMarch 25, 2025 17:10
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
578e720 to
4c96f33CompareMarch 25, 2025 17:28
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
4c96f33 to
93f6112CompareMarch 25, 2025 17:54
@jathu
jathu
marked this pull request as ready for review
March 25, 2025 17:55
larryliu0820
larryliu0820
reviewed
Mar 25, 2025
View reviewed changes
Comment threadinstall_executorch.py
Outdated

swolchok
swolchok
reviewed
Mar 25, 2025
View reviewed changes
Comment threadsetup.py
mergennachin
mergennachin
requested changes
Mar 25, 2025
View reviewed changes
@mergennachinmergennachin
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comment
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
6949e35 to
5501b06CompareMarch 25, 2025 18:39
@jathu
jathu
requested a review
from mergennachinMarch 25, 2025 18:40
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
b989433 to
36ae47eCompareMarch 25, 2025 18:51
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
63c33b8 to
a5e6fcfCompareMarch 25, 2025 19:35
@jathu
jathuforce-pushed
the
jathu/use-cmake-args
branch
from
a5e6fcf to
69a5ba4CompareMarch 25, 2025 20:49
@jathu
jathu
merged commit be3c1ec
into
mainMar 25, 2025
@jathu
jathu
deleted the

jathu/use-cmake-args

branch
March 25, 2025 22:10
@jathujathu
mentioned this pull request
Mar 31, 2025
 Merged

jathu added a commit
that referenced
this pull request
Mar 31, 2025
@jathu
Update pybinding README (#9770)
ea2029d
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Remove usage of environment variables in wheel building (#9583)
15e9123
### Summary
We seem to be using a combination of CMAKE_ARGS and environment
variables when creating wheels. Ultimately, CMake only uses the cmake
args, however we redefine some of these flags as env vars to help
`setup.py` determine if a certain feature is turned on. Specifically, it
looks for pybinding vars to bundle pybindings.
Let's remove this redundancy and just use the CMAKE_ARGS as the single
source of truth. For more details and other considerations, see
#9494 (abandoned).
Note that even in the wheel building jobs, we use cmake args instead of
environment variables to control features:
https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_base.sh#L20https://github.com/pytorch/executorch/blob/644b7ddf14180d97e348faa627f576e13d367d69/.ci/scripts/wheel/envvar_macos.sh#L14-L15
### Test plan
build + check CMakeCache.txt to ensure flags are set
```bash
# Expected: EXECUTORCH_BUILD_PYBIND=OFF EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh --pybind off
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=OFF
$ rm -rf pip-out dist && ./install_executorch.sh
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=OFF EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml
# Expected: EXECUTORCH_BUILD_PYBIND=ON EXECUTORCH_BUILD_XNNPACK=ON EXECUTORCH_BUILD_COREML=ON
$ rm -rf pip-out dist && ./install_executorch.sh --pybind xnnpack coreml
# Throws an error
$ rm -rf pip-out dist && ./install_executorch.sh --pybind coreml off
```
cc @larryliu0820@lucylq
kirklandsign pushed a commit
that referenced
this pull request
Apr 11, 2025
@jathu@kirklandsign
Update pybinding README (#9770)
ad0ab96
### Summary
After #9583 and
#9611, we don't rely on
environment variables to turn on pybindings.
### Test plan
Read + run example commands.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@larryliu0820larryliu0820larryliu0820 approved these changes
@mergennachinmergennachinmergennachin approved these changes

+1 more reviewer

@swolchokswolchokswolchok left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

ciflow/binariesciflow/trunkCLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: build/installIssues related to the cmake and buck2 builds, and to installing ExecuTorchtopic: not user facing

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@jathu@swolchok@mergennachin@larryliu0820@facebook-github-bot