Add new export + lowering docs, update getting started #8412
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/8412
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
GregoryComer
force-pushed
the
getting-started-example-model
branch
2 times, most recently
from
4a2555d to
08f902f
Compare
GregoryComer
changed the title
byjlw
approved these changes
Feb 12, 2025
mergennachin
requested changes
Feb 12, 2025
| Exporting requires the ExecuTorch python libraries to be installed, typically by running `pip install executorch`. See [Installation](getting-started.md#Installation) for more information. This process assumes you have a PyTorch model, can instantiate it from Python, and can provide example input tensors to run the model. | ||
|
|
||
| ## The Export and Lowering Process |
There was a problem hiding this comment.
Can we cross-reference to this page/diagram?
https://pytorch.org/executorch/main/getting-started-architecture.html
There was a problem hiding this comment.
Let's chat more about this as a follow-up, if that's okay. The thing I don't love about that diagram is that it's almost a full page long and potentially intimidating. I would like to include more diagrams, but I wonder if we can create a simplified one for the getting started / high-level documentation.
|
|
||
| For more information, see [Runtime API Reference](executorch-runtime-api-reference.md). | ||
|
|
There was a problem hiding this comment.
Another "advanced" topic I'd like to see is other options for delegate here:
In particular,
- composing a lowered module into another module is a good one.
- using multiple partitioners, use CoreML and fallback to XNNPACK for instance
There was a problem hiding this comment.
Makes sense. I'll take that as a follow-up.
GregoryComer
force-pushed
the
getting-started-example-model
branch
from
08f902f to
5555623
Compare
GregoryComer
added a commit
to GregoryComer/executorch
that referenced
this pull request
Feb 23, 2025
Write new top-level export and lowering documentation
GregoryComer
added a commit
that referenced
this pull request
Feb 23, 2025
Write new top-level export and lowering documentation
GregoryComer
added a commit
that referenced
this pull request
Feb 26, 2025
Write new top-level export and lowering documentation
GregoryComer
added a commit
that referenced
this pull request
Feb 26, 2025
* New Getting Started documentation (#8179) WIP New getting started * Update documentation flow and add placeholders (#8287) Add placeholder top-level doc pages * Add new export + lowering docs, update getting started (#8412) Write new top-level export and lowering documentation * More doc placeholders (#8523) * Move cmake and faq docs to new location * Rename CMake build to Building from Source * Move backend docs to new locations (#8413) * Temporarily remove new backend pages * Move backend docs to new locations * Update backend titles and inline contents * Backend doc template (#8524) Add backend template, update XNNPACK docs * Add runtime integration documentation (#8516) Add runtime integration doc * Move iOS docs to top, add Android placeholders (#8511) * Temporarily remove using-executorch-ios.md * Move Apple runtime docs to new location * Clean up documentation placeholders and links, add top-level docs for C++ APIs, Android, and troubleshooting (#8618) * Clean up getting-started.md, remove placeholders * Move Android pre-built AAR info into top-level Android page * Add placeholder backend overview * Add placeholder troubleshooting docs * Populate top-level C++ API doc * Clean up additional doc placeholders and fix broken links * Add env setup instructions for source build * Fix getting started code snippet (#8637) Fix quotes in getting started code snippets * Clean up a few more doc sections and links (#8672) Clean up a few more broken links and sections in new doc flow * Fix QNN link, typo (#8729) * Add a CMake snippet to the XNNPACK backend doc build section (#8730) Add CMake example to xnnpack backend doc
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
This PR adds a new top-level export and lowering documentation page, starts work on updating the getting started guide to use MV3 as an example model. I'm still working on finding the right balance of depth and accessibility. I'd be interested in any thoughts on this point.
This represents an iterative step towards the end goal of a cleaner doc flow. I find that working in this manner helps to guide the overall structure and flow of the documentation experience. As such, this is not intended to represent the final product for the docs that are being changed, but should be a step forward.
Test plan
Built docs locally and inspected the output.