A short term fix for editable mode install failed to import root level module such as exir#9818
Merged
larryliu0820 merged 6 commits intomainfrom Apr 2, 2025
Merged
A short term fix for editable mode install failed to import root level module such as exir#9818larryliu0820 merged 6 commits intomainfrom
larryliu0820 merged 6 commits intomainfrom
Conversation
…l module such as exir Summary: Fixes #9558. The `src/executorch/exir` file exists primarily due to the limitations of `pip install` in editable mode. Specifically, `pip install -e .` does not recognize `<executorch root>/exir` (or any root level directory with a `__init__.py`) as a valid package module because of the presence of `<executorch root>/exir/__init__.py`. See the following GitHub issue for details: [Issue #9558](#9558). To work around this limitation, a symlink is used. With this symlink and this package entry in `pyproject.toml`: ```toml [tool.setuptools.package-dir] ... "executorch" = "src/executorch" ``` We are telling `pip install -e .` to treat `src/executorch` as the root of the `executorch` package and hence mapping `executorch.exir` to `src/executorch/exir`. This allows us to perform `pip install -e .` successfully and enables the execution of the following command: ```bash python -c "from executorch.exir import CaptureConfig" ``` Test Plan: ```bash ./install_executorch.sh --pybind --editable python -c "from executorch.exir import CaptureConfig" ``` Reviewers: Subscribers: Tasks: Tags:
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/9818
Note: Links to docs will display an error until the docs builds have been completed. ⏳ 3 Pending, 1 Unrelated FailureAs of commit f599c9f with merge base b66c319 ( FLAKY - The following job failed but was likely due to flakiness present on trunk:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
larryliu0820
changed the title
Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
Contributor
|
Why only exir? What if we have a symlink from |
Contributor
Author
Gee, I think that's better. I don't think we should symlink the whole root directory, instead we probably want to symlink all next level directories with python file. |
larryliu0820
added
release notes: build
swolchok
approved these changes
Apr 2, 2025
Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
Contributor
Author
Actually tested Same problem so in this update I symlink'd all the modules |
Contributor
|
@mergennachin you probably want to take a look at this |
kirklandsign
pushed a commit
that referenced
this pull request
Apr 11, 2025
…l module such as exir (#9818) Summary: Fixes #9558. The `src/executorch/exir` file exists primarily due to the limitations of `pip install` in editable mode. Specifically, `pip install -e .` does not recognize `<executorch root>/exir` (or any root level directory with a `__init__.py`) as a valid package module because of the presence of `<executorch root>/exir/__init__.py`. See the following GitHub issue for details: [Issue #9558](#9558). To work around this limitation, a symlink is used. With this symlink and this package entry in `pyproject.toml`: ```toml [tool.setuptools.package-dir] # ... "executorch" = "src/executorch" ``` We are telling `pip install -e .` to treat `src/executorch` as the root of the `executorch` package and hence mapping `executorch.exir` to `src/executorch/exir`. This effectively gets `exir` out from the root level package. This allows us to perform `pip install -e .` successfully and enables the execution of the following command: ```bash python -c "from executorch.exir import CaptureConfig" ``` Test Plan: ```bash ./install_executorch.sh --pybind --editable python -c "from executorch.exir import CaptureConfig" ``` Reviewers: Subscribers: Tasks: Tags:
This was referenced Apr 14, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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:
Fixes #9558.
The
src/executorch/exirfile exists primarily due to the limitations ofpip installin editable mode. Specifically,pip install -e .does not recognize<executorch root>/exir(or any root level directory with a__init__.py) as a valid package module because of the presence of<executorch root>/exir/__init__.py. See the following GitHub issue for details: Issue #9558.To work around this limitation, a symlink is used. With this symlink and this package entry in
pyproject.toml:We are telling
pip install -e .to treatsrc/executorchas the root of theexecutorchpackage and hence mappingexecutorch.exirtosrc/executorch/exir. This effectively getsexirout from the root level package.This allows us to perform
pip install -e .successfully and enables the execution of the following command:python -c "from executorch.exir import CaptureConfig"Test Plan:
./install_executorch.sh --pybind --editable python -c "from executorch.exir import CaptureConfig"Reviewers:
Subscribers:
Tasks:
Tags: