Skip to content

[Docathon] Fix docathon content issues#19444

Open
ozgecinko wants to merge 1 commit into
pytorch:mainfrom
ozgecinko:doc-content-change
Open

[Docathon] Fix docathon content issues#19444
ozgecinko wants to merge 1 commit into
pytorch:mainfrom
ozgecinko:doc-content-change

Conversation

@ozgecinko
Copy link
Copy Markdown

@ozgecinko ozgecinko commented May 10, 2026

Summary

Fixes #19258

Updated several documentation pages from the docathon issue:

  • Fixed empty wrapper pages for desktop Core ML, desktop MPS, and embedded Arm Ethos-U by pointing them to the correct backend overview docs.
  • Removed unnecessary single-entry Arm Ethos-U and Arm VGF tutorial index pages and linked directly to the Getting Started tutorials.
  • Fixed the empty Runtime subsection in the Arm VGF tutorial.
  • Expanded the Backend Dialect section in the Export IR specification with a short explanation and pointer to the detailed doc.
  • Clarified the API Life Cycle “How to Mark API State” table.
  • Fixed the quantize_ typo in XNNPACK quantization docs.
  • Updated Samsung Exynos navigation after Cadence and linked the Android Samsung wrapper to the real Samsung overview page.
  • Updated the Tools section Model Visualization link to point to visualize.md.

Test plan

  • Ran git diff --check.
  • Manually checked that old broken references and typos are no longer present with rg.
  • Ran a local Sphinx docs build:
LC_ALL=C python -m sphinx -b html docs/source /private/tmp/executorch-docs-html -W --keep-going

cc @mergennachin @AlannaBurke @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell @rascani

@ozgecinko ozgecinko requested a review from mergennachin as a code owner May 10, 2026 19:58
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 10, 2026

🔗 Helpful Links

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

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

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

❌ 1 New Failure, 6 Unrelated Failures

As of commit a99414a with merge base e25369b (image):

NEW FAILURE - The following job has failed:

FLAKY - The following jobs failed but were likely due to flakiness present on trunk:

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

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

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 10, 2026

Hi @ozgecinko!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@github-actions github-actions Bot added the module: arm Issues related to arm backend label May 10, 2026
@ozgecinko
Copy link
Copy Markdown
Author

@pytorchbot label "docathon-2026"

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 10, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@meta-cla 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 May 10, 2026
@mergennachin mergennachin requested a review from psiddh May 11, 2026 15:28
@ozgecinko
Copy link
Copy Markdown
Author

@pytorchbot label "release notes: none"

@pytorch-bot pytorch-bot Bot added the release notes: none Do not include this in the release notes label May 12, 2026
@github-actions github-actions Bot added medium Medium Difficulty for issues as part of PyTorch Docathon H1 2026 module: doc Issues related to documentation, both in docs/ and inlined in code labels May 12, 2026
@ozgecinko
Copy link
Copy Markdown
Author

ozgecinko commented May 12, 2026

This PR only changes documentation files, including documentation text under XNNPACK, so I believe these CI failures are unrelated to the doc changes. Could someone please rerun the failed jobs or help clarify whether any action is needed from my side? @psiddh @mergennachin

@nil-is-all nil-is-all self-requested a review May 12, 2026 16:30
@psiddh
Copy link
Copy Markdown
Contributor

psiddh commented May 12, 2026

This PR only changes documentation files, including documentation text under XNNPACK, so I believe these CI failures are unrelated to the doc changes. Could someone please rerun the failed jobs or help clarify whether any action is needed from my side? @psiddh @mergennachin

The failed CI jobs are unrelated to the ongoing changes

@psiddh
Copy link
Copy Markdown
Contributor

psiddh commented May 12, 2026

Rebasing the PR now. Overall the changes lgtm

@psiddh psiddh force-pushed the doc-content-change branch from 5938045 to a99414a Compare May 12, 2026 18:07
@psiddh
Copy link
Copy Markdown
Contributor

psiddh commented May 12, 2026

@claude review the doc changes

@claude
Copy link
Copy Markdown

claude Bot commented May 12, 2026

Claude finished @psiddh's task in 1m 56s —— View job


Documentation Review

  • Gather context and read changed files
  • Review wrapper page fixes (desktop-coreml, desktop-mps, embedded-arm-ethos-u)
  • Review removed tutorial index pages and related changes
  • Review content additions (ir-exir, api-life-cycle, backends-overview)
  • Review typo fixes and link updates (xnnpack, tools-section, samsung)
  • Review conf.py changes
  • Post final review feedback

Overall this is a solid documentation cleanup PR. The changes fix real broken references and improve content clarity. Here's my detailed review:

Wrapper pages (desktop-coreml, desktop-mps, embedded-arm-ethos-u, android-samsung-exynos) ✅

All four wrapper pages correctly point to the actual backend overview files that exist in the repo. The old targets (backends-coreml.md, backends-mps.md, backends-arm-ethos-u.md) no longer exist but have proper redirects already set up in conf.py. Good fix.

Removed tutorial index pages ✅

Deleting arm-ethos-u-tutorials.md and arm-vgf-tutorials.md makes sense — they were thin wrappers containing only a single entry. The parent overviews and android-examples.md now link directly to the getting-started tutorials. The corresponding redirect entries in conf.py ensure old URLs still resolve.

Heading fix in vgf-getting-started.md

The original had inverted heading levels (### Runtime:## Build executor runtime). The fix correctly uses ## Runtime### Build executor runtime### Deploying and running on device, which matches the document's top-level # Getting Started Tutorial.

api-life-cycle.md table restructuring ✅

The original table crammed Deprecated and Experimental into single cells per language with <p> separators and stray </ul> tags. The rewrite gives each (Language, API State) pair its own row and adds a proper "API state" column header. This is much clearer. The addition of "Stable" and "Deleted" rows is useful context.

Minor note: the HTML still has a few raw <p> tags before <pre><code> blocks (e.g., lines 210, 245). These work but could be cleaned up to be consistent with the rest of the table which avoids them. Not a blocker.

Backend Dialect section in ir-exir.md

Good expansion. The previous one-liner See this [doc](compiler-backend-dialect.md) is replaced with a concise explanation of what backend dialect is, when it's used, and a pointer to the detailed doc. The referenced compiler-backend-dialect.md exists in the repo.

XNNPACK quantization typo fixes ✅

Three typo fixes:

  • embeedingsembeddings
  • qunatize_quantize_
  • # Quatize# Quantize

All correct.

Pre-existing issue (not introduced by this PR): The code example defines embedding_config but never passes it to quantize_() on line 82-84. The call should be quantize_(eager_model, embedding_config, ...). This is a bug in the original doc, not something this PR needs to fix, but worth noting for a follow-up.

tools-section.md change ⚠️

The change from {doc}\visualize`toModel Visualizationand fromvisualizetoModel Visualization in the toctree works, but it's inconsistent with the other entries on the page which all use{doc}references. Was this changed because the{doc}reference wasn't resolving? Ifvisualize.mdexists (it does), the original{doc}`visualize`should also work. Consider keeping the{doc}` style for consistency unless there's a specific Sphinx issue motivating this.

backends-overview.md toctree fix ✅

Adding the display title Samsung Exynos Backend <backends/samsung/samsung-overview> in the toctree is correct and ensures the entry shows a readable name in the navigation sidebar.

embedded-backends.md minor fix ✅

Capitalizing "ARM" → "Arm" matches the official Arm branding. Also adds the missing closing ``` for the toctree block.

conf.py redirects ✅

Adding redirects for the deleted tutorial index pages ensures existing bookmarks/links continue to work.


Summary: This PR is in good shape. The only minor suggestion is the tools-section.md style inconsistency with [Model Visualization](visualize.md) vs {doc} — but if there's a reason for it (e.g., Sphinx build warning), it's fine as-is. LGTM for merge.

@nil-is-all
Copy link
Copy Markdown
Contributor

nil-is-all commented May 12, 2026

Thanks for the PR, @ozgecinko! Just wanted to confirm few of the changes with the file owners, such as the deprecation details in the API Life Cycle table and Backend Dialect for Export IR.

Comment thread docs/source/ir-exir.md
## Backend Dialect

See this [doc](compiler-backend-dialect.md)
Backend dialect is the optional, target-aware stage after Edge dialect. It is
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@GregoryComer Can you review this part ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The content looks accurate to me. It lines up with what we have in the existing docs, so no concerns from me.

Copy link
Copy Markdown
Contributor

@psiddh psiddh left a comment

Choose a reason for hiding this comment

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

I will go over this change one more time before +1

</td>
<td>Stable
</td>
<td>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

we need to take a closer look at this table and see if it helps the doc readers now that we are refactoring ...

The other way could be to leave the changes of this file as-is as before.
Will lean on @GregoryComer for some feedback here

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Sure, the live version is a bit unclear. Content-wise, I think having extra column is good. We maybe can do some formatting updates to de-clutter the page. I'd lean slightly towards dropping the two "All" rows, but I don't feel strongly about it. I don't have any blocking concerns.

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. docathon-2026 medium Medium Difficulty for issues as part of PyTorch Docathon H1 2026 module: arm Issues related to arm backend module: doc Issues related to documentation, both in docs/ and inlined in code release notes: none Do not include this in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Content changes required in Doc page

4 participants