Backend doc template #8524
Merged
Backend doc template #8524
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/8524
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
delegate-doc-template
branch
from
eac2994 to
bf938cc
Compare
|
Tentatively merging this to unblock doc work. Feel free to leave comments and I will address as a follow-up. |
GregoryComer
merged commit 6ab321a
into
pytorch:executorch-just-works
4 of 5 checks passed
| @@ -1,146 +1,69 @@ | |||
| # XNNPACK Backend | |||
|
|
|||
| This is a high-level overview of the ExecuTorch XNNPACK backend delegate. This high performance delegate is aimed to reduce CPU inference latency for ExecuTorch models. We will provide a brief introduction to the XNNPACK library and explore the delegate’s overall architecture and intended use cases. | |||
| The XNNPACK delegate is the ExecuTorch solution for CPU execution on mobile CPUs. XNNPACK is a library that provides optimized kernels for machine learning operators on Arm and x86 CPUs. | |||
There was a problem hiding this comment.
Reference to https://github.com/google/XNNPACK
| @@ -1,146 +1,69 @@ | |||
| # XNNPACK Backend | |||
|
|
|||
| This is a high-level overview of the ExecuTorch XNNPACK backend delegate. This high performance delegate is aimed to reduce CPU inference latency for ExecuTorch models. We will provide a brief introduction to the XNNPACK library and explore the delegate’s overall architecture and intended use cases. | |||
There was a problem hiding this comment.
There are a lot of good content in this old document. But I agree that it is not really relevant for users, mainly around implementation details. So it's good that we made it crisper.
I would actually preserve a lot of the old documents (https://pytorch.org/executorch/stable/native-delegates-executorch-xnnpack-delegate.html) and move to "Backend Development" section. XNNPACK delegate is the most mature backend, and serve as a good reference implementation for new backends.
Maybe call it "Backend Development: Case study on XNNPACK" or something like that.
cc @digantdesai
| .set_object_type(torch.nn.functional.linear, quantization_config) # or torch functional op typea | ||
| .set_module_name("foo.bar", quantization_config) # or by module fully qualified name | ||
| ``` | ||
| The XNNPACK delegate is included by default in the published Android, iOS, and pip packages. When building from source, pass `-DEXECUTORCH_BUILD_XNNPACK=ON` when configuring the CMake build to compile the XNNPACK backend. |
There was a problem hiding this comment.
This section really needs to be improved. Having three reference implementations:
- CMake file for C++
- iOS
- Android
| print(quantized_model) | ||
| ``` | ||
| You will now see the Q/DQ representation of the model, which means `torch.ops.quantized_decomposed.dequantize_per_tensor` are inserted at quantized operator inputs and `torch.ops.quantized_decomposed.quantize_per_tensor` are inserted at operator outputs. Example: | ||
| ### Runner |
There was a problem hiding this comment.
Instead of calling "Runner", maybe call "Testing"?
There was a problem hiding this comment.
Also, before testing in C++, can you add testing via pybind section?
GregoryComer
added a commit
to GregoryComer/executorch
that referenced
this pull request
Feb 23, 2025
Add backend template, update XNNPACK docs
GregoryComer
added a commit
that referenced
this pull request
Feb 23, 2025
Add backend template, update XNNPACK docs
GregoryComer
added a commit
that referenced
this pull request
Feb 26, 2025
Add backend template, update XNNPACK docs
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
Add a template for backend docs under Backends/. Update XNNPACK doc to follow the new template.
Test plan
Built docs locally.