Update XNNPACK doc structure and add template by GregoryComer · Pull Request #14873 · pytorch/executorch

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.

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

AWS was down, GHA infrastructure effected / recovering

❌ 6 New Failures, 1 Cancelled Job, 13 Pending

As of commit ed22ca6 with merge base 7d4db45 ():

NEW FAILURES - The following jobs have failed:

pull / test-samsung-models-linux / linux-job (gh)
RuntimeError: Command docker exec -t 99076bd313aa48888239087498dd4975219c4bbe64496fdaf458f19d6c8576ee /exec failed with exit code 1
pull / unittest-nxp-neutron / linux-job (gh)
RuntimeError: Command docker exec -t 882107cd7f9724473b5e8da7e4cd9d28dfa5f23beb5ba126e19dc19a832e9e39 /exec failed with exit code 1
Test CUDA Builds / export-voxtral-cuda-non-quantized / linux-job (gh)
RuntimeError: Command docker exec -t 332da75be6cc49ef79faa256c18a7cc89a04460cb4780e9dd0f8a2d2bbd876a9 /exec failed with exit code 2
Test CUDA Builds / export-voxtral-cuda-quantized-int4-tile-packed / linux-job (gh)
RuntimeError: Command docker exec -t d9857b33bbe25b8b548d91370eb789bbea402586e8cb1c2de395c46826398518 /exec failed with exit code 2
Test CUDA Builds / export-voxtral-cuda-quantized-int4-weight-only / linux-job (gh)
RuntimeError: Command docker exec -t 1ab450393b91856b7f8e2c8f588950d6208365ae88299cb03f8d330f23a6ea16 /exec failed with exit code 2
Test Metal Backend / export-voxtral-metal-artifact / macos-job (gh)
RuntimeError: Command bash /Users/ec2-user/runner/_work/_temp/exec_script failed with exit code 2

CANCELLED JOB - The following job was cancelled. Please retry:

pull / unittest / macos / macos-job (gh)
##[error]The operation was canceled.

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

+| 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

@@ -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?

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

+
+## 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).


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

+: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

+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)

mergennachin · 2025-10-15T13:20:22Z

Now the chevron button doesn't collapse/expand on the left nav

https://docs-preview.pytorch.org/pytorch/executorch/14873/android-xnnpack.html?v=10

and the links down below in the page doesn't work

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

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

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

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

robert-kalmar · 2025-10-17T12:44:20Z

+backend-op-support
+backend-arch-internals
+tutorials/backend-tutorials
+guides/backend-guides


Closing " ``` " missing

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

GregoryComer · 2025-10-20T21:11:14Z

I've fixed the last couple of links and am merging as is. The issue with expanding the menu for backends under Android/iOS doesn't seem to be resolved when increased the max TOC depth under edge-platform-sections, so we'll need to investigate - we can take as a follow-up.

digantdesai · 2025-10-21T11:59:27Z

Thanks @GregoryComer!

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

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)

Updating per template in #14873 Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>

Updating per template in pytorch#14873 Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>

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

### 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)

Updating per template in pytorch#14873 Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>

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

Comment thread docs/source/backends/xnnpack/xnnpack-overview.md Outdated

SS-JIA reviewed Oct 10, 2025

View reviewed changes

Comment thread docs/source/backends/xnnpack/xnnpack-overview.md Outdated

digantdesai reviewed Oct 10, 2025

View reviewed changes

Comment thread docs/source/backends/template/README.md Outdated

metascroy mentioned this pull request Oct 11, 2025

Core ML doc updates #15033

Closed

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

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

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

[ET-VK][docs] Update to the new template

72c4c60

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

SS-JIA mentioned this pull request Oct 15, 2025

[ET-VK][docs] Update to the new template #14996

Merged

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

[Samsung][docs] Update to the new template

7d1bba8

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

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

[Samsung][docs] Update to the new template

43613b4

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

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

[ET-VK][docs] Update to the new template

2d9e333

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

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

[Samsung][docs] Update to the new template (#15087)

39f474f

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

robert-kalmar mentioned this pull request Oct 17, 2025

NXP Backend: Update documentation to the new scheme #15219

Merged

robert-kalmar reviewed Oct 17, 2025

View reviewed changes

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

[ET-VK][docs] Update to the new template

9bb807f

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

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

[ET-VK][docs] Update to the new template

c149913

Summary: Title says it all! Add Vulkan docs in accordance to the format for XNNPACK introduced in #14873.

GregoryComer force-pushed the new-backend-docs branch 2 times, most recently from 796d05c to 3f45145 Compare October 18, 2025 00:45

GregoryComer added 5 commits October 20, 2025 10:59

Prototype updated XNNPACK doc structure

6151087

Add op support table

94a8ad1

Minor cleanup

8f383e3

Fix xnnpack link under android

896cd8b

More link fixes

ed22ca6

GregoryComer force-pushed the new-backend-docs branch from 3f45145 to ed22ca6 Compare October 20, 2025 18:17

GregoryComer merged commit 0a1dfb2 into pytorch:main Oct 20, 2025
133 of 143 checks passed

GregoryComer pushed a commit to GregoryComer/executorch that referenced this pull request Oct 22, 2025

[Samsung][docs] Update to the new template (pytorch#15087)

15be82f

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

robert-kalmar added a commit that referenced this pull request Dec 12, 2025

NXP Backend: Update documentation to the new scheme (#15219)

cdc2701

Updating per template in #14873 Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>

xingguo01 pushed a commit to xingguo01/executorch that referenced this pull request Dec 18, 2025

NXP Backend: Update documentation to the new scheme (pytorch#15219)

845a4c5

Updating per template in pytorch#14873 Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>

jirioc pushed a commit to nxp-upstream/executorch that referenced this pull request Dec 19, 2025

[Samsung][docs] Update to the new template (pytorch#15087)

787d8a1

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

jirioc pushed a commit to nxp-upstream/executorch that referenced this pull request Dec 19, 2025

NXP Backend: Update documentation to the new scheme (pytorch#15219)

06908d9

Updating per template in pytorch#14873 Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>

		@@ -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).

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

❗ 1 Active SEVs

❌ 6 New Failures, 1 Cancelled Job, 13 Pending

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!

mergennachin commented Oct 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

digantdesai commented Oct 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

GregoryComer commented Oct 8, 2025 •

edited

Loading

pytorch-bot Bot commented Oct 8, 2025 •

edited

Loading

This PR needs a `release notes:` label

GregoryComer commented Oct 20, 2025 •

edited

Loading