Skip to content

Add editable mode in Building from source file #8882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 3, 2025
Merged

Add editable mode in Building from source file #8882

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b4f907
Add editable mode in Building from source file
mergennachin Mar 3, 2025
5cb2798
Update using-executorch-building-from-source.md
mergennachin Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/using-executorch-building-from-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ portability details.
./install_executorch.sh --pybind off
```

For development, install the package in `--editable` mode, which allows to modify Python source code and see changes reflected immediately.
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for adding this to the docs. In the long-term, I wonder if we should split out contributing vs user build from source info, but we don't really have a great place for it for now, so this seems good.

```
./install_executorch.sh --editable [--pybind xnnpack]

# Or you can directly do the following if dependencies are already installed.
pip install -e .
```

> **_NOTE:_** Cleaning the build system
>
> When fetching a new version of the upstream repo (via `git fetch` or `git
Expand Down
Loading