Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Arm backend: update docs to new template #9712

Merged
merged 1 commit into from
Apr 1, 2025

Conversation

Erik-Lundell
Copy link
Collaborator

@Erik-Lundell Erik-Lundell commented Mar 27, 2025

The old doc follows the tutorial template and has thus been moved to a new file tutorial-arm-ethos-u.md. backend-arm-ethos-u now instead follows the new backend-template.md.

Additinally, make sure both files follow the points iterated in #8530

cc @digantdesai @freddan80 @per @zingo @oscarandersson8218

The old doc follows the tutorial template and has thus been moved
to a new file tutorial-arm-ethos-u.md. backend-arm-ethos-u now
instead follows the new backend-template.md.

Additinally, make sure both files follow the points iterated in
pytorch#8530

Signed-off-by: Erik Lundell <[email protected]>
Change-Id: If77ba6c54d9c726a369f98c28cf42712cd32d511
@Erik-Lundell Erik-Lundell added partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm topic: not user facing labels Mar 27, 2025
Copy link

pytorch-bot bot commented Mar 27, 2025

🔗 Helpful Links

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

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

✅ No Failures

As of commit 2804540 with merge base 976fe48 (image):
💚 Looks good so far! There are no failures yet. 💚

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

@facebook-github-bot facebook-github-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 Mar 27, 2025
@mergennachin
Copy link
Contributor

@Erik-Lundell

How will the tutorial-arm-ethos-u.md page (https://docs-preview.pytorch.org/pytorch/executorch/9712/tutorial-arm-ethos-u.html) be referenced? Seems like an orphan page?

https://docs-preview.pytorch.org/pytorch/executorch/9712/index.html

In general, what do you think is a user journey should be for a user who's interested in enabling Arm backend?

Copy link
Contributor

@digantdesai digantdesai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stamping to unblock. See v0.6 and if we want this to get cherry picked.

@@ -1,434 +1,101 @@
<!---- Name is a WIP - this reflects better what it can do today ----->
# ARM Ethos-U Backend
# Arm(R) Ethos(TM)-U NPU Backend
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add another line somewhere saying registered trademark of Arm etc.?

Suggested change
# Arm(R) Ethos(TM)-U NPU Backend
# Arm Ethos-U NPU Backend

@GregoryComer
Copy link
Member

Thanks for taking this. Looks great. If there's any other information that you want to include that doesn't strictly fit in the template, feel free to add it.

@Erik-Lundell
Copy link
Collaborator Author

@Erik-Lundell

How will the tutorial-arm-ethos-u.md page (https://docs-preview.pytorch.org/pytorch/executorch/9712/tutorial-arm-ethos-u.html) be referenced? Seems like an orphan page?

https://docs-preview.pytorch.org/pytorch/executorch/9712/index.html

In general, what do you think is a user journey should be for a user who's interested in enabling Arm backend?

We are currently revamping this, for example adding a proper minimal example in our examples folder (#9543). I think we can leave it as an orphan while we create a unified story for new users.

@zingo zingo merged commit dc93fde into pytorch:main Apr 1, 2025
81 of 82 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm topic: not user facing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants