Arm backend: Create documents for the supported operators#17847
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/17847
Note: Links to docs will display an error until the docs builds have been completed. ❌ 3 New FailuresAs of commit 735a1dd with merge base dae7a02 ( NEW FAILURES - The following jobs have failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This PR needs a
|
There was a problem hiding this comment.
Pull request overview
Adds operator-support documentation pages for Arm backends (VGF and Ethos-U) and links them from the backend overview/reference sections.
Changes:
- Link new operator-support pages from the Arm VGF overview page.
- Link new operator-support pages (U55/U85) from the Arm Ethos-U overview page.
- Introduce three new Markdown pages listing supported EdgeIR operators for VGF, U55, and U85.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source/backends/arm-vgf/arm-vgf-overview.md | Adds a reference link to the new VGF operator support page. |
| docs/source/backends/arm-vgf/VGF_op_support.md | New operator support matrix page for VGF. |
| docs/source/backends/arm-ethos-u/arm-ethos-u-overview.md | Adds reference links to new U55/U85 operator support pages. |
| docs/source/backends/arm-ethos-u/U55_op_support.md | New operator support matrix page for Ethos-U55. |
| docs/source/backends/arm-ethos-u/U85_op_support.md | New operator support matrix page for Ethos-U85. |
Comments suppressed due to low confidence (11)
docs/source/backends/arm-vgf/VGF_op_support.md:3
- This page uses a level-2 heading (
##) as the first header. Other backend docs use a level-1 page title (# ...), which is important for consistent sidebar/page titles in Sphinx/MyST; consider changing this to a top-level#heading.
## EdgeIR Operator support for the VGF backend
This list contains operators with silicon acceleration support. The ExecuTorch portable kernels allow running more operations with a fallback.
8x8 designates 8-bit activation and 8-bit weight. 16x8 means 16-bit activation and 8-bit weight. Per-tensor and per-channel quantization are supported.
docs/source/backends/arm-vgf/VGF_op_support.md:8
- The table header says "Compute DType" but the values in that column are "Static integer quantization" (a quantization scheme, not a dtype). Please rename the column (e.g., "Compute type" / "Quantization scheme") or update the values to actual dtypes (e.g., int8) so the table is internally consistent.
| EdgeIR operator | Compute DType | Quantization |
| --------------- | ------------------------------| ------------ |
| _log_softmax.default | Static integer quantization | 8x8 |
| _native_batch_norm_legit_no_training.default | Static integer quantization | 8x8 |
docs/source/backends/arm-vgf/VGF_op_support.md:10
- Operator names like
_log_softmax.defaultstart with underscores; in Markdown these often get parsed as emphasis, which can render the names incorrectly. Consider wrapping all operator names in inline code (backticks) (or escaping underscores) so they render verbatim.
| _log_softmax.default | Static integer quantization | 8x8 |
| _native_batch_norm_legit_no_training.default | Static integer quantization | 8x8 |
| _softmax.default | Static integer quantization | 8x8 |
| _to_copy.default | Static integer quantization | 8x8 |
docs/source/backends/arm-ethos-u/U55_op_support.md:10
- Operator names beginning with
_...are likely to be mis-rendered by Markdown as italics/emphasis. Wrapping the operator names in inline code (backticks) (or escaping underscores) will ensure the names display exactly as written.
| _log_softmax.default | Static integer quantization | 8x8 |
| _softmax.default | Static integer quantization | 8x8 |
| _to_copy.default | Static integer quantization | 8x8 |
| abs.default | Static integer quantization | 8x8 |
docs/source/backends/arm-ethos-u/arm-ethos-u-overview.md:241
U55_op_supportandU85_op_supportare linked in the Reference section, but neither page is included in the hidden{toctree}. This can trigger Sphinx "document isn't included in any toctree" warnings and makes the pages harder to discover via sidebar navigation; add them to the toctree (or mark the pages as orphan if intentionally excluded).
**→{doc}`/backends/arm-ethos-u/U55_op_support` — Ethos-U55 supported operators.**
**→{doc}`/backends/arm-ethos-u/U85_op_support` — Ethos-U85 supported operators.**
```{toctree}
:maxdepth: 2
:hidden:
:caption: Arm Ethos-U Backend
arm-ethos-u-partitioner
arm-ethos-u-quantization
arm-ethos-u-troubleshooting
tutorials/arm-ethos-u-tutorials
**docs/source/backends/arm-ethos-u/U55_op_support.md:3**
* This page uses a level-2 heading (`##`) as the first header. For consistency with other backend docs (which typically use `#` for the page title), consider making this a top-level heading so Sphinx/MyST generates the expected page title.
EdgeIR Operator support for the U55 backend
This list contains operators with silicon acceleration support. The ExecuTorch portable kernels allow running more operations with a fallback.
8x8 designates 8-bit activation and 8-bit weight. 16x8 means 16-bit activation and 8-bit weight. Per-tensor and per-channel quantization are supported.
**docs/source/backends/arm-ethos-u/U55_op_support.md:12**
* The table header says "Compute DType" but the entries in that column are "Static integer quantization" (not a dtype). Rename the column or adjust the column values so the semantics match and readers can interpret the support matrix correctly.
| EdgeIR operator | Compute DType | Quantization |
|---|---|---|
| _log_softmax.default | Static integer quantization | 8x8 |
| _softmax.default | Static integer quantization | 8x8 |
| _to_copy.default | Static integer quantization | 8x8 |
| abs.default | Static integer quantization | 8x8 |
| acos.default | Static integer quantization | 8x8 |
| adaptive_avg_pool2d.default | Static integer quantization | 16x8 / 8x8 |
**docs/source/backends/arm-ethos-u/U85_op_support.md:3**
* This page starts with a level-2 heading (`##`). For consistency with the rest of the backend docs and to ensure Sphinx/MyST uses it as the page title, consider switching this to a level-1 `#` heading.
EdgeIR Operator support for the U85 backend
This list contains operators with silicon acceleration support. The ExecuTorch portable kernels allow running more operations with a fallback.
8x8 designates 8-bit activation and 8-bit weight. 16x8 means 16-bit activation and 8-bit weight. Per-tensor and per-channel quantization are supported.
**docs/source/backends/arm-ethos-u/U85_op_support.md:11**
* The column labeled "Compute DType" contains "Static integer quantization" values, which is not a dtype. Please rename this column or change the values to actual compute dtypes so the table isn't misleading.
| EdgeIR operator | Compute DType | Quantization |
|---|---|---|
| _log_softmax.default | Static integer quantization | 8x8 |
| _softmax.default | Static integer quantization | 8x8 |
| abs.default | Static integer quantization | 8x8 |
| acos.default | Static integer quantization | 8x8 |
| adaptive_avg_pool2d.default | Static integer quantization | 16x8 / 8x8 |
**docs/source/backends/arm-ethos-u/U85_op_support.md:9**
* Operator names with leading underscores (e.g., `_log_softmax.default`) can be parsed by Markdown as emphasis and render incorrectly. Wrap the operator names in inline code (backticks) (or escape underscores) to preserve the literal operator spelling.
| _log_softmax.default | Static integer quantization | 8x8 |
| _softmax.default | Static integer quantization | 8x8 |
| abs.default | Static integer quantization | 8x8 |
**docs/source/backends/arm-vgf/arm-vgf-overview.md:153**
* The new operator-support page is linked in the Reference list but not included in the page's hidden toctree. Sphinx commonly emits a "document isn't included in any toctree" warning for such pages; add `VGF_op_support` to the `{toctree}` (or explicitly mark the page as orphan) to avoid doc build warnings and ensure the page is discoverable in navigation.
→{doc}/backends/arm-vgf/VGF_op_support — VGF supported operators.
:maxdepth: 2
:hidden:
:caption: Arm VGF Backend
arm-vgf-partitioner
arm-vgf-quantization
arm-vgf-troubleshooting
tutorials/arm-vgf-tutorials
</details>
---
💡 <a href="/pytorch/executorch/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
for the three Arm backends. Signed-off-by: George Gekov Change-Id: Ia1656ce36cd1715ff06477e414881a98bee7005b
8c227af to
735a1dd
Compare
for the three Arm backends.
cc @digantdesai @SS-JIA @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell