Skip to content

Update Arm Ethos U backend docs using backend template #8530

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.

Sign up for GitHub

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

Jump to bottom
Open
GregoryComer opened this issue Feb 18, 2025 · 4 comments
Open

Update Arm Ethos U backend docs using backend template #8530

GregoryComer opened this issue Feb 18, 2025 · 4 comments
Assignees
@Erik-Lundell
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Milestone
0.6.0

Comments

@GregoryComer
Copy link
Member

GregoryComer commented Feb 18, 2025 •
edited by pytorch-bot bot
Loading

📚 The doc issue

Note: This issue pertains to the executorch-just-works branch. It is intended to merge back into master within the next 1-2 weeks.

Update the Arm Ethos-U backend top-level documentation page (docs/source/backends-arm-ethos-u.md) to use the new backend template (docs/source/backend-template.md). See the backend-xnnpack.md for an example. Feel free to deviate or suggest changes to the template if it does not make sense for this backend.

General documentation guidelines that I'm hoping to follow:

Suggest a potential alternative/fix

No response

cc @mergennachin @byjlw @digantdesai @freddan80 @per @zingo @oscarandersson8218
@GregoryComer GregoryComer added module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Feb 18, 2025
@github-project-automation github-project-automation bot moved this to To triage in ExecuTorch DevX Feb 18, 2025
@Erik-Lundell
Copy link
Collaborator

Hi Gregory, thanks for the heads up. I have created a mirroring internal ticket, we'll get to it :)

@mergennachin mergennachin moved this from To triage to Backlog in ExecuTorch DevX Feb 18, 2025
@mergennachin mergennachin added this to the 0.6.0 milestone Feb 18, 2025
@mergennachin mergennachin moved this from Backlog to Ready in ExecuTorch DevX Feb 18, 2025
Erik-Lundell added a commit to Erik-Lundell/executorch that referenced this issue Mar 27, 2025
@Erik-Lundell
Arm backend: update docs to new template
2804540 
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 <erik.lundell@arm.com>
Change-Id: If77ba6c54d9c726a369f98c28cf42712cd32d511
@Erik-Lundell Erik-Lundell mentioned this issue Mar 27, 2025
Merged
@Erik-Lundell
Copy link
Collaborator

Hello @GregoryComer, this is our suggestion for the updated docs: #9712.
I noticed that our earlier backends-arm-ethos-u uses the tutorial template so I kept it, renaming it to tutorial-arm-ethos-u.md. Seems like xnnpack does something similar. WDYT?

@Erik-Lundell
Copy link
Collaborator

Hey @GregoryComer, we'll merge this soon-ish and update later if you have any comments.

zingo pushed a commit that referenced this issue Apr 1, 2025
@Erik-Lundell
Arm backend: update docs to new template (#9712)
dc93fde 
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

Signed-off-by: Erik Lundell <erik.lundell@arm.com>
@mergennachin
Copy link
Contributor

@Erik-Lundell , @zingo thoughts on cherry-picking #9712 into release/0.6 branch?

See instructions in #9253

kirklandsign pushed a commit that referenced this issue Apr 11, 2025
@Erik-Lundell @kirklandsign
Arm backend: update docs to new template (#9712)
cbba24e 
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

Signed-off-by: Erik Lundell <erik.lundell@arm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Erik-Lundell Erik-Lundell

Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
ExecuTorch DevX
Status: Ready
Milestone
0.6.0
Development

No branches or pull requests
3 participants
@mergennachin @GregoryComer @Erik-Lundell