Arm backend: Split Arm tutorial into ethosu and vgf #14299

Erik-Lundell · 2025-09-15T15:39:09Z

Align with minimal examples with regards to content and code.

cc @digantdesai @freddan80 @per @zingo @oscarandersson8218

pytorch-bot · 2025-09-15T15:39:12Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR

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

❌ 1 New Failure

As of commit 8476448 with merge base f6a5fa0 ():

NEW FAILURE - The following job has failed:

pull / unittest / macos / macos-job (gh)
exir/tests/test_quant_fusion_pass.py::TestQuantFusionPass::test_embedding_torchao

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

mergennachin · 2025-09-15T15:48:02Z

@zingo @Erik-Lundell @agrima1304

There are four pages now...

https://docs.pytorch.org/executorch/main/backends-arm-ethos-u.html
https://docs.pytorch.org/executorch/main/backends-arm-vgf.html

and these two tutorial pages

What's the long term plan?

digantdesai · 2025-09-15T17:31:29Z

docs/source/tutorial-arm-ethos-u.md

@@ -0,0 +1,215 @@
+# Arm&reg; Ethos&trade;-U NPU Backend Tutorial


&reg and &trade in title feels odd - too corporate :p
We can put it somewhere on the page that Arm is a registered trademark etc..

I am not a lawyer :P

In the interest of time and to stay consistent with our backend docs, I'll keep this for now. We can follow up on this later. (I am also not a lawyer so I'd have to do some looking-into-the-matter)

Fixed it :)

digantdesai · 2025-09-15T17:34:00Z

docs/source/index.md

 Building an ExecuTorch Android Demo App <https://github.com/pytorch-labs/executorch-examples/tree/main/dl3/android/DeepLabV3Demo#executorch-android-demo-app>
 Building an ExecuTorch iOS Demo App <https://github.com/meta-pytorch/executorch-examples/tree/main/mv3/apple/ExecuTorchDemo>
-tutorial-arm.md
+tutorial-arm-ethosu.md


I do see this https://docs- preview.pytorch.org/pytorch/executorch/14299/backends-arm-vgf.html but not under backends, is that intentional?

I think that is fixed here? 3acd431

Hm , I see what you mean now. I get the same problems with the tutorials, only the VGF tutorial shows up in the sidebar 🤔

No, it was a typo 🥇 Fingers crossed that this is last adjustment

digantdesai · 2025-09-15T17:34:18Z

docs/source/tutorial-arm-vgf.md

@@ -0,0 +1,216 @@
+ Arm&reg; VGF Backend Tutorial


same here about &reg

s/vgf/Vulkan Graph Format/ ?

Fun fact - VGF does not stand for that :)

digantdesai

Just skimmed, stamping to unblock.
If you want this to get cherry-picked please mention it in 1.0 release tracker.

Erik-Lundell · 2025-09-16T07:20:17Z

@zingo @Erik-Lundell @agrima1304

There are four pages now...

https://docs.pytorch.org/executorch/main/backends-arm-ethos-u.html https://docs.pytorch.org/executorch/main/backends-arm-vgf.html

and these two tutorial pages

What's the long term plan?

Our plan is that the tutorials essentially are an online version of the minimal_example Jupyter notebooks, for people that don't clone the repo. They are a step-by-step guides on how to do your first lowering. The backend documents all public API and some additional information about the target (Partitioner, Quantizer, CompileSpec, Ethos-U memory modes etc.)

Since the backends are for very separate targets, I don't think it makes sense to mix them, even if the code looks rather similar.

Align with minimal examples with regards to content and code. Signed-off-by: Erik Lundell <[email protected]> Change-Id: Iaa2a8abc46483c3f2cd4313212ea58284804fd65

digantdesai · 2025-09-16T15:46:51Z

Yeah I think treating ethos and vgf as completely independent backend from a user reading a doc is the right approach.

And for a given backend, my thinking for backend dev page and a backend [tutorial] page is that, the backend dev page talks about architecture, internals - something like a big picture design which you can't glean easily from reading the code or makes life much easier for someone wants to understand the code base before contributing. For tutorial is more like for a user trying to "try out" the backend without necessarily learning about the internal details.

This is inspired from -

https://docs.divio.com/documentation-system/

for XNNPACK (not in the best shape today) but
https://docs.pytorch.org/executorch/main/backend-delegates-xnnpack-reference.html - for devs
https://docs.pytorch.org/executorch/main/backends-xnnpack.html and https://docs.pytorch.org/executorch/main/tutorial-xnnpack-delegate-lowering.html - for users

Erik-Lundell · 2025-09-17T06:55:58Z

Yeah I think treating ethos and vgf as completely independent backend from a user reading a doc is the right approach.

And for a given backend, my thinking for backend dev page and a backend [tutorial] page is that, the backend dev page talks about architecture, internals - something like a big picture design which you can't glean easily from reading the code or makes life much easier for someone wants to understand the code base before contributing. For tutorial is more like for a user trying to "try out" the backend without necessarily learning about the internal details.

This is inspired from -

https://docs.divio.com/documentation-system/

for XNNPACK (not in the best shape today) but https://docs.pytorch.org/executorch/main/backend-delegates-xnnpack-reference.html - for devs https://docs.pytorch.org/executorch/main/backends-xnnpack.html and https://docs.pytorch.org/executorch/main/tutorial-xnnpack-delegate-lowering.html - for users

I really like that classification, thanks!

zingo · 2025-09-17T11:19:17Z

@pytorchbot cherry-pick --onto release/1.0 -c docs

Align with minimal examples with regards to content and code. Signed-off-by: Erik Lundell <[email protected]> (cherry picked from commit d25c35a)

pytorchbot · 2025-09-17T11:21:38Z

Cherry picking #14299

The cherry pick PR is at #14372 The following tracker issues are updated:

[v1.0.0] Release Tracker #14288 (comment)

Details for Dev Infra team

Raised by workflow job

Align with minimal examples with regards to content and code. Signed-off-by: Erik Lundell <[email protected]>

Erik-Lundell requested a review from mergennachin as a code owner September 15, 2025 15:39

Erik-Lundell added partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm release notes: arm Changes to the ARM backend delegate labels Sep 15, 2025

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 Sep 15, 2025

zingo added this to the 1.0.0 milestone Sep 15, 2025

digantdesai reviewed Sep 15, 2025

View reviewed changes

digantdesai approved these changes Sep 15, 2025

View reviewed changes

Erik-Lundell force-pushed the only-doc branch from d4b82eb to b8566bc Compare September 16, 2025 09:42

Erik-Lundell added release tracker and removed release tracker labels Sep 16, 2025

Erik-Lundell force-pushed the only-doc branch 2 times, most recently from be25c95 to d9a6b74 Compare September 16, 2025 14:06

Arm backend: Split Arm tutorial into ethosu and vgf

8476448

Align with minimal examples with regards to content and code. Signed-off-by: Erik Lundell <[email protected]> Change-Id: Iaa2a8abc46483c3f2cd4313212ea58284804fd65

Erik-Lundell force-pushed the only-doc branch from d9a6b74 to 8476448 Compare September 16, 2025 14:54

zingo merged commit d25c35a into pytorch:main Sep 17, 2025
124 of 125 checks passed

pytorchbot pushed a commit that referenced this pull request Sep 17, 2025

Arm backend: Split Arm tutorial into ethosu and vgf (#14299)

52ac6fb

Align with minimal examples with regards to content and code. Signed-off-by: Erik Lundell <[email protected]> (cherry picked from commit d25c35a)

pytorchbot mentioned this pull request Sep 17, 2025

[v1.0.0] Release Tracker #14288

Closed

StrycekSimon pushed a commit to nxp-upstream/executorch that referenced this pull request Sep 23, 2025

Arm backend: Split Arm tutorial into ethosu and vgf (pytorch#14299)

7993142

Align with minimal examples with regards to content and code. Signed-off-by: Erik Lundell <[email protected]>

Arm backend: Split Arm tutorial into ethosu and vgf #14299

Arm backend: Split Arm tutorial into ethosu and vgf #14299

Uh oh!

Conversation

Erik-Lundell commented Sep 15, 2025 • edited by pytorch-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Sep 15, 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/14299

❌ 1 New Failure

Uh oh!

mergennachin commented Sep 15, 2025

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!

Erik-Lundell Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Choose a reason for hiding this comment

Uh oh!

digantdesai left a comment

Choose a reason for hiding this comment

Uh oh!

Erik-Lundell commented Sep 16, 2025

Uh oh!

digantdesai commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Erik-Lundell commented Sep 17, 2025

Uh oh!

zingo commented Sep 17, 2025

Uh oh!

pytorchbot commented Sep 17, 2025

Cherry picking #14299

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Erik-Lundell commented Sep 15, 2025 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented Sep 15, 2025 •

edited

Loading

Erik-Lundell Sep 16, 2025 •

edited

Loading

digantdesai commented Sep 16, 2025 •

edited

Loading