-
Notifications
You must be signed in to change notification settings - Fork 696
Update build from source and getting started docs #15311
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.
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
Update build from source and getting started docs #15311
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/15311
Note: Links to docs will display an error until the docs builds have been completed. ❌ 2 New Failures, 55 PendingAs of commit 8d9b821 with merge base fe3c1dc ( NEW FAILURES - The following jobs have failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
5260ced to
38fa8ba
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that you removed but I recommend adding back a brief "Verify Your Build" section after the Building section that contains
- One-line command to export a simple model
- One-line command to run it with the executor_runner
Sounds good. I'll re-add. The reason I removed it was partly because we don't actually build the executor_runner for most presets and it requires multiple CLI options to include. I'm a little conflicted on this, but maybe we should build by default? I think it does make sense to have a quick verification step. I'll re-add. |
38fa8ba to
8d9b821
Compare
Added. |
### Summary Update Getting Started and Build from Source Docs: * Integrate Windows steps into the main flow with minor Windows-specific callouts. * Clarify top-level flow for building from source - add a table by use case. * Clarify building ET as a submodule vs standalone build. * Re-order, re-word, and clean up the content related to building from source. * Add info on NDK build for Android. Tracked in pytorch#14791 and pytorch#14759. cc @mergennachin @byjlw
Summary
Update Getting Started and Build from Source Docs:
Tracked in #14791 and #14759.
cc @mergennachin @byjlw