Update XNNPACK doc structure and add template #14873

GregoryComer · 2025-10-08T01:53:06Z

Summary

Prototype an updated doc structure for the XNNPACK backend. Extract a common template out under docs/source/backends/tempate/

This PR updates the doc structure as follows. Under the template, the landing page is required, partitioner, quantization, and op support docs are recommended, and the rest are optional.

XNNPACK Backend
- Quantization (recommended)
- Partitioner APIs (recommended)
- Operator Support (optional)
- Architecture and Internals (optional)
- Tutorials (optional)
- Guides (optional)

pytorch-bot · 2025-10-08T01:53:10Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/14873

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 11 New Failures

As of commit 5b91e6e with merge base 019c8da ():

NEW FAILURES - The following jobs have failed:

Lint / link-check / lint-xrefs / linux-job (gh)
RuntimeError: Command docker exec -t df6289598249ad6f4b17c338796552b8e9c976509610292f17df671b830137a0 /exec failed with exit code 1
pull / test-qnn-wheel-packages-linux (3.10) / linux-job (gh)
RuntimeError: Command docker exec -t e14b19756e7a22fb0ecfed39b932dccd5f18eb87265bf1e49256a3fab707304c /exec failed with exit code 1
pull / test-qnn-wheel-packages-linux (3.11) / linux-job (gh)
RuntimeError: Command docker exec -t f4020826b7fd5271dcd82f8166687b3e9e89dc2bd9ac4e80ef63ebb611323477 /exec failed with exit code 1
pull / test-qnn-wheel-packages-linux (3.12) / linux-job (gh)
RuntimeError: Command docker exec -t 07fffffcabb7ceb5b16147d6413e526d0f4767c420f6a0c50d30a0df2d08a2c1 /exec failed with exit code 1
pull / test-samsung-models-linux / linux-job (gh)
RuntimeError: Command docker exec -t b0dc72b97267e3214e53bd4b5a5adbec1d9c3c5acd02c6d2dcf7cc5f5342cbc1 /exec failed with exit code 1
Test CUDA Builds / export-voxtral-cuda-artifact / linux-job (gh)
RuntimeError: Command docker exec -t fddc68a5766552183241c2826b258050a660b06fa385fa514854a8795113e293 /exec failed with exit code 2
Test CUDA Builds / test-models-cuda (add_mul) / linux-job (gh)
RuntimeError: Command docker exec -t 44dc36da4fc42184e39ef4d8ad123f5b0f346ec85b83127382df229753612599 /exec failed with exit code 1
Test CUDA Builds / test-models-cuda (add) / linux-job (gh)
RuntimeError: Command docker exec -t d12cebe536bd97dc799abefcaae206bbc89a164c59b4551e3245385c823b465a /exec failed with exit code 1
Test CUDA Builds / test-models-cuda (conv1d) / linux-job (gh)
RuntimeError: Command docker exec -t 277b4972bf7f4f0aa5b63a4b273fe888c82ef129ea0591dd0507d6d38a0bb12c /exec failed with exit code 1
Test CUDA Builds / test-models-cuda (linear) / linux-job (gh)
RuntimeError: Command docker exec -t f05ab8cd931bf26b202f4eed1f8e50e4b284cf60f24f9b700ba2b03ebe915eda /exec failed with exit code 1
Test CUDA Builds / test-models-cuda (resnet18) / linux-job (gh)
RuntimeError: Command docker exec -t d9fa474b0bd91cbad321911d3b8016569ae34314877c3316888af8c260bc1d8f /exec failed with exit code 1

This comment was automatically generated by Dr. CI and updates every 15 minutes.

github-actions · 2025-10-08T01:53:47Z

This PR needs a `release notes:` label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

GregoryComer · 2025-10-08T02:09:20Z

This is a pretty early draft, but I'd be interested in any thoughts.
https://docs-preview.pytorch.org/pytorch/executorch/14873/backends/xnnpack/xnnpack-overview.html

CC @digantdesai @psiddh @mergennachin @cccclai @metascroy

metascroy · 2025-10-09T17:51:50Z

docs/source/backends-overview.md

+| Backend                                       | Platform(s)         | Hardware Type | Typical Use Case                |
+|-----------------------------------------------|---------------------|---------------|---------------------------------|
+| [XNNPACK](backends/xnnpack/xnnpack-overview)              | All                 | CPU           | General-purpose, fallback       |
+| [Core ML](backends-coreml)                    | iOS, macOS          | NPU/GPU       | Apple devices, high performance |


CoreML is CPU too

digantdesai

LGTM, left some comments.

digantdesai · 2025-10-09T12:35:32Z

docs/source/backends/template/guides/backend-basic-guide.md

@@ -0,0 +1,3 @@
+# Using {FEATURE} on {BACKEND_NAME}
+
+This is a placeholder guide.


Can we add meta details about the intended use of this section?

docs/source/backends/template/guides/backend-tutorials.md

digantdesai · 2025-10-09T12:38:57Z

docs/source/backends/template/tutorials/backend-basic-tutorial.md

+
+## Step 1: Environment Setup
+
+This tutorial is intended to be run from a {SUPPORTED_HOST_OS} and uses Conda for Python environment management. For full setup details and system requirements, see [Getting Started with ExecuTorch](/getting-started).


docs/source/backends/template/README.md

docs/source/backends/xnnpack/op-support.csv

docs/source/backends-overview.md

docs/source/backends/xnnpack/xnnpack-overview.md

docs/source/backends/template/README.md

mergennachin · 2025-10-13T13:19:38Z

docs/source/backends/template/backend-overview.md

+:hidden:
+:caption: {BACKEND} Backend
+
+backend-troubleshooting


np: do you wanna put the troubleshooting section a bit further back in the list?

I think we went back and forth (literally on the list too :p)

I updated to put it after partitioner and quant docs, but before arch + internals. Does that work?

digantdesai · 2025-10-13T16:03:59Z

docs/source/backends/template/backend-overview.md

+backend-troubleshooting
+backend-partitioner
+backend-quantization
+backend-op-support


thinking more, technically op-support can be under partitioner.

So thinking out loud,

partitioner, quantizer (two entry point, separate pages)

tutorials (curious why it is not here?)

internals (can also house reference material facts which can't be part of parishioner or quantizer)

guide/troubleshooting/gotcha/faq (one page with a title reflecting it is for all these :p)

That seems reasonable. I've updated to move op support into the partitioner page. I also added tutorials to the TOC in the template - good catch.

mergennachin · 2025-10-13T16:09:01Z

@GregoryComer @digantdesai

Under Edge Platforms (iOS, Android, Desktop, C++) etc

I don't see XNNPACK anymore on the left nav "Edge->Android->Backends", as well as the overview page

https://docs-preview.pytorch.org/pytorch/executorch/14873/android-backends.html (no link to XNNPACK)

https://docs-preview.pytorch.org/pytorch/executorch/14873/android-section.html (no XNNPACK on left nav)

Summary: Title says it all! Add docs for the Samsung backend based on the template introduced in #14873.

meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 8, 2025

GregoryComer force-pushed the new-backend-docs branch 3 times, most recently from 15169b1 to bd30b09 Compare October 8, 2025 22:00

GregoryComer changed the title ~~[WIP] Prototype updated XNNPACK doc structure~~ [WIP] Update XNNPACK doc structure Oct 8, 2025

GregoryComer force-pushed the new-backend-docs branch from bd30b09 to 42a6b71 Compare October 9, 2025 07:18

GregoryComer changed the title ~~[WIP] Update XNNPACK doc structure~~ Update XNNPACK doc structure and add template Oct 9, 2025

GregoryComer requested review from SS-JIA, cccclai, digantdesai, metascroy and psiddh October 9, 2025 07:20

GregoryComer marked this pull request as ready for review October 9, 2025 07:21

GregoryComer requested a review from mergennachin as a code owner October 9, 2025 07:21

GregoryComer requested a review from abhinaykukkadapu October 9, 2025 07:22

metascroy reviewed Oct 9, 2025

View reviewed changes

digantdesai approved these changes Oct 9, 2025

View reviewed changes

GregoryComer force-pushed the new-backend-docs branch from 42a6b71 to b577bd8 Compare October 10, 2025 07:16

SS-JIA reviewed Oct 10, 2025

View reviewed changes

docs/source/backends/xnnpack/xnnpack-overview.md Outdated Show resolved Hide resolved

SS-JIA reviewed Oct 10, 2025

View reviewed changes

docs/source/backends/xnnpack/xnnpack-overview.md Outdated Show resolved Hide resolved

digantdesai reviewed Oct 10, 2025

View reviewed changes

docs/source/backends/template/README.md Outdated Show resolved Hide resolved

metascroy mentioned this pull request Oct 11, 2025

Core ML doc updates #15033

Closed

Prototype updated XNNPACK doc structure

66e459f

GregoryComer force-pushed the new-backend-docs branch 2 times, most recently from 67f0493 to 592f698 Compare October 13, 2025 06:02

mergennachin reviewed Oct 13, 2025

View reviewed changes

digantdesai reviewed Oct 13, 2025

View reviewed changes

SS-JIA added a commit that referenced this pull request Oct 14, 2025

[Samsung] Docs template

9dd2292

Summary: Title says it all! Add docs for the Samsung backend based on the template introduced in #14873.

SS-JIA mentioned this pull request Oct 14, 2025

[Samsung] Docs template #15087

Open

Add op support table

baaeab7

GregoryComer force-pushed the new-backend-docs branch from 592f698 to baaeab7 Compare October 14, 2025 22:44

Minor cleanup

1379b98

GregoryComer force-pushed the new-backend-docs branch from 8d763b9 to 1379b98 Compare October 14, 2025 23:13

GregoryComer added 2 commits October 14, 2025 16:16

Fix xnnpack link under android

0e61278

More link fixes

5b91e6e

		@@ -0,0 +1,3 @@
		# Using {FEATURE} on {BACKEND_NAME}

		This is a placeholder guide.


		## Step 1: Environment Setup

		This tutorial is intended to be run from a {SUPPORTED_HOST_OS} and uses Conda for Python environment management. For full setup details and system requirements, see [Getting Started with ExecuTorch](/getting-started).

Update XNNPACK doc structure and add template #14873

Are you sure you want to change the base?

Update XNNPACK doc structure and add template #14873

Conversation

GregoryComer commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

pytorch-bot bot commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/14873

❌ 11 New Failures

Uh oh!

github-actions bot commented Oct 8, 2025

This PR needs a release notes: label

Uh oh!

GregoryComer commented Oct 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

digantdesai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mergennachin commented Oct 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

GregoryComer commented Oct 8, 2025 •

edited

Loading

pytorch-bot bot commented Oct 8, 2025 •

edited

Loading

This PR needs a `release notes:` label