NXP Backend: Update documentation to the new scheme#15219
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/15219
Note: Links to docs will display an error until the docs builds have been completed. ❌ 6 New Failures, 1 Unrelated FailureAs of commit 8df2c41 with merge base b6935ad ( NEW FAILURES - The following jobs have failed:
UNSTABLE - The following job is marked as unstable, possibly due to flakiness on trunk:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This PR needs a
|
92eb4cb to
fb21899
Compare
roman-janik-nxp
left a comment
There was a problem hiding this comment.
Just backend with capital B and I see no further issues.
| @@ -1,79 +0,0 @@ | |||
| # NXP eIQ Neutron Backend | |||
There was a problem hiding this comment.
there's another reference of this https://github.com/pytorch/executorch/blob/53c1a77166c6478ad30b0e1c0e2c4f5247693e6a/docs/source/embedded-nxp.md?plain=1
There was a problem hiding this comment.
There was a problem hiding this comment.
Thanks, fixed.
fb21899 to
50e151c
Compare
There was a problem hiding this comment.
In the XNNPACK files I see both, there is capital Backend in "XNNPACK Backend" at least in headings. What I meant is to unify it, as we have strings "NXP Backend" as well as "NXP backend". That is just a cosmetic issue. As it is a backend name, I think both words should be capitalized as it is a general rule in English. XNNPACK docs can also have mistakes.
EDIT: I have looked on other backends and they are mostly inconsistent too. It should be one or the other, but always capitalized in headings.
50e151c to
02374b7
Compare
You are right, with the consistency. Went through it and unified it to use lower case everywhere. So Neutron backend, Neutron partitioner, Neutron quantizer.... |
|
|
||
| ## Step 1: Environment Setup | ||
|
|
||
| This tutorial is intended to be run from a Linux and uses Conda or Virtual Env for Python environment management. For full setup details and system requirements, see [Getting Started with ExecuTorch](/getting-started). |
There was a problem hiding this comment.
This link gives 404.
|
@robert-kalmar there's a merge conflict, can you rebase please |
02374b7 to
9db5587
Compare
Signed-off-by: Robert Kalmar <robert.kalmar@nxp.com>
9db5587 to
8df2c41
Compare
|
Failures seems unrelated. |
Updating per template in pytorch#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>
The backends-overview page was only showing 6 backends instead of 13. This regression was introduced in commit cdc2701 (NXP Backend: Update documentation to the new scheme #15219) which inadvertently reverted correct toctree paths to incorrect ones during a table reformatting. - Toctree entries used old flat paths (e.g., backends-xnnpack) instead of the new subdirectory paths (e.g., backends/xnnpack/xnnpack-overview) - A circular toctree dependency between nxp-overview.md and nxp-dim-order.md caused Sphinx build failures Test Plan: Built sphinx locally and rendered page https://docs-preview.pytorch.org/pytorch/executorch/16861/backends-section.html
The backends-overview page was only showing 6 backends instead of 13. This regression was introduced in commit cdc2701 (NXP Backend: Update documentation to the new scheme #15219) which inadvertently reverted correct toctree paths to incorrect ones during a table reformatting. - Toctree entries used old flat paths (e.g., backends-xnnpack) instead of the new subdirectory paths (e.g., backends/xnnpack/xnnpack-overview) - A circular toctree dependency between nxp-overview.md and nxp-dim-order.md caused Sphinx build failures Test Plan: Built sphinx locally and rendered page https://docs-preview.pytorch.org/pytorch/executorch/16861/backends-section.html (cherry picked from commit 29b31da)
The backends-overview page was only showing 6 backends instead of 13. This regression was introduced in commit cdc2701 (NXP Backend: Update documentation to the new scheme #15219) which inadvertently reverted correct toctree paths to incorrect ones during a table reformatting. - Toctree entries used old flat paths (e.g., backends-xnnpack) instead of the new subdirectory paths (e.g., backends/xnnpack/xnnpack-overview) - A circular toctree dependency between nxp-overview.md and nxp-dim-order.md caused Sphinx build failures Test Plan: Built sphinx locally and rendered page https://docs-preview.pytorch.org/pytorch/executorch/16861/backends-section.html Co-authored-by: Mergen Nachin <mnachin@meta.com>
Updating per template in #14873
cc @JakeStevens @digantdesai