Create a helper to define overridable configs #10731
Merged
+447
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/10731
Note: Links to docs will display an error until the docs builds have been completed. ❌ 1 New Failure, 2 PendingAs of commit 738e250 with merge base cebe051 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
jathu
added
topic: not user facing
and removed
CLA Signed
facebook-github-bot
added
the
CLA Signed
jathu
force-pushed
the
jathu/create-define-config
branch
2 times, most recently
from
0016cdd to
ec90eda
Compare
jathu
force-pushed
the
jathu/create-define-config
branch
2 times, most recently
from
171b0de to
dcf72ee
Compare
jathu
force-pushed
the
jathu/create-define-config
branch
from
dcf72ee to
50c54c1
Compare
larryliu0820
reviewed
May 7, 2025
| return result | ||
|
|
||
|
|
||
| class CMakeTestCase(unittest.TestCase): |
There was a problem hiding this comment.
Wow thanks for writing the tests! I didn't know CMake is testable
larryliu0820
reviewed
May 7, 2025
larryliu0820
reviewed
May 7, 2025
larryliu0820
reviewed
May 7, 2025
larryliu0820
reviewed
May 7, 2025
larryliu0820
approved these changes
May 7, 2025
larryliu0820
reviewed
May 7, 2025
jathu
added
module: build/install
jhelsby
pushed a commit
to jhelsby/executorch
that referenced
this pull request
May 9, 2025
### Summary Context: pytorch#10661. As part pytorch#10716, this creates a helper to define ET configs. #### Why define_overridable_config? This is a simple wrapper to configure an option via the user or fallback to a default value. Instead of having people do this manually, this is convenient and consistent. More specifically: - If the option is set via the CLI or `set`, then save that value in the cache — with our own description - If the option is unset, then fallback to the default value The user options will be loaded *before* loading the `default.cmake` file. This means, when we load the default file, we can use the user set options or fallback on defaults. Then finally we can do a final sweet of option validations. After this point, all options will be frozen and immutable. Moreover, having a helper function will allow us to enforce standards on options. For example, naming standards done in this PR. #### Migration plan For now, I've only migrated a simple option `EXECUTORCH_ENABLE_LOGGING`. We'll incrementally migrate remaining options in future PRs. ### Test plan For changes to `EXECUTORCH_ENABLE_LOGGING`, I changed the release modes and checked the finaly `CMakeCache.txt` file. Rely on CI for full tests. For python tests: ``` $ python3 -m unittest discover -s tools/cmake -p "*.py" ``` I will include this test in CI in the next diff.
jackzhxng
added
release notes: examples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Context: #10661. As part #10716, this creates a helper to define ET configs.
Why define_overridable_config?
This is a simple wrapper to configure an option via the user or fallback to a default value. Instead of having people do this manually, this is convenient and consistent. More specifically:
set, then save that value in the cache — with our own descriptionThe user options will be loaded before loading the
default.cmakefile. This means, when we load the default file, we can use the user set options or fallback on defaults. Then finally we can do a final sweet of option validations. After this point, all options will be frozen and immutable.Moreover, having a helper function will allow us to enforce standards on options. For example, naming standards done in this PR.
Migration plan
For now, I've only migrated a simple option
EXECUTORCH_ENABLE_LOGGING. We'll incrementally migrate remaining options in future PRs.Test plan
For changes to
EXECUTORCH_ENABLE_LOGGING, I changed the release modes and checked the finalyCMakeCache.txtfile. Rely on CI for full tests.For python tests:
I will include this test in CI in the next diff.
cc @larryliu0820