Skip to content

Bulk cherry-pick doc updates #15338

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
Merged
GregoryComer merged 26 commits into from
Oct 22, 2025
Merged

Bulk cherry-pick doc updates #15338

GregoryComer merged 26 commits into from
Oct 22, 2025

Conversation

@GregoryComer
Copy link
Member

@GregoryComer GregoryComer commented Oct 22, 2025 •
edited
Loading

Summary

Bulk pick doc updates using https://github.com/pytorch/executorch/blob/main/scripts/pick_doc_commits.py.

I also manually included eb05056, which has some example changes, since it's a doc update PR.

I sanity checked this by running git diff HEAD upstream/main -- docs/source and the diff didn't show any surprises. There were some changes on main related to larger PRs that haven't been picked (NXP visualizer, for example), but everything else is in sync.

roman-janik-nxp and others added 24 commits October 21, 2025 17:18
@roman-janik-nxp @GregoryComer
NXP backend: Update user guide and docs Readme (pytorch#14852)
d45304b 
This PR updates NXP backend Readmes in backend and examples directories.

-

cc @robert-kalmar @JakeStevens @digantdesai
@mergennachin @GregoryComer
Update top-level README.md file (pytorch#15049)
7505b16
@mergennachin @GregoryComer
Fix documentation link for Core ATen operators (pytorch#15050)
15ccdf5 
Updated link to Core ATen operator set documentation.

### Summary
[PLEASE REMOVE] See [CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests)
for ExecuTorch PR guidelines.

[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes
#<issue-id>` line.

[PLEASE REMOVE] If this PR introduces a fix or feature that should be
the upcoming release notes, please add a "Release notes: <area>" label.
For a list of available release notes labels, check out
[CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).

### Test plan
[PLEASE REMOVE] How did you test this PR? Please write down any manual
commands you used and note down tests that you have written if
applicable.
@mergennachin @GregoryComer
Fix various minor links in top-level README.md (pytorch#15052)
3c8f647
@robert-kalmar @GregoryComer
NXP Backend: Update Readme files (pytorch#14896)
68e587a
@SS-JIA @GregoryComer
[Samsung][docs] Update to the new template (pytorch#15087)
15be82f 
Summary:
Title says it all!

Add docs for the Samsung backend based on the template introduced in
pytorch#14873.
@psiddh @GregoryComer
Add Pico2 Tutorials on Raspberry Pi (pytorch#15188)
6108d6b 
### Summary
Add Pico2 Tutorials on Raspberry Pi 

[PLEASE REMOVE] See [CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests)
for ExecuTorch PR guidelines.

[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes
#<issue-id>` line.

[PLEASE REMOVE] If this PR introduces a fix or feature that should be
the upcoming release notes, please add a "Release notes: <area>" label.
For a list of available release notes labels, check out
[CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).

### Test plan
[PLEASE REMOVE] How did you test this PR? Please write down any manual
commands you used and note down tests that you have written if
applicable.
@metascroy @GregoryComer
Update mps docs and fix coreml/mps doc references (pytorch#15179)
c00cd39
@SS-JIA @GregoryComer
[ET-VK][docs] Update to the new template (pytorch#14996)
a566c09
@mergennachin @GregoryComer
Success Stories page initial stage (pytorch#15236)
56ee96b
@psiddh @GregoryComer
Android Documentation Improvements and other fixes (pytorch#15260)
923761c 
1. Make Android doc more Dev focused / friendly
(Quick Start Navigation , More Clear Pathfinding & Logical Flow for
Devs)
3. Update links to be relevant in Android  sections
4. Fix the broken vulkan & coreML links from Android & iOS flow
5. Fix navigation related issues

[PLEASE REMOVE] See [CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests)
for ExecuTorch PR guidelines.

[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes

[PLEASE REMOVE] If this PR introduces a fix or feature that should be
the upcoming release notes, please add a "Release notes: <area>" label.
For a list of available release notes labels, check out
[CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).

[PLEASE REMOVE] How did you test this PR? Please write down any manual
commands you used and note down tests that you have written if
applicable.
@psiddh @GregoryComer
Updated Android doc with proper 1.0.0 backend links to executorch (py…
3d6b5d1 
…torch#15266)

### Summary
[PLEASE REMOVE] See [CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests)
for ExecuTorch PR guidelines.

[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes
#<issue-id>` line.

[PLEASE REMOVE] If this PR introduces a fix or feature that should be
the upcoming release notes, please add a "Release notes: <area>" label.
For a list of available release notes labels, check out
[CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).

### Test plan
[PLEASE REMOVE] How did you test this PR? Please write down any manual
commands you used and note down tests that you have written if
applicable.
@psiddh @GregoryComer
Android Docs: Fix stale backend link (android-samsung-exynos) (pytorc…
4a73a87 
…h#15287)

[PLEASE REMOVE] See [CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests)
for ExecuTorch PR guidelines.

[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes

[PLEASE REMOVE] If this PR introduces a fix or feature that should be
the upcoming release notes, please add a "Release notes: <area>" label.
For a list of available release notes labels, check out
[CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).

[PLEASE REMOVE] How did you test this PR? Please write down any manual
commands you used and note down tests that you have written if
applicable.
@jackzhxng @GregoryComer
Export LLMs with Optimum docs (pytorch#15062)
11ff6e9
@SS-JIA @GregoryComer
[ET-VK] Add redirect for backends-vulkan (pytorch#15305)
8d6d4d2 
Summary:
Title says it all!

cc @manuelcandales @digantdesai @cbilgin
@shoumikhin @GregoryComer
Revise ExecuTorch documentation for Apple runtime (pytorch#15293)
7aa15fe
@shoumikhin @GregoryComer
Update docs on LMM runner Apple API (pytorch#15307)
146c8cb
@manuelcandales @GregoryComer
Add Metal backend documentation to Voxtral README (pytorch#15273)
8711ebd 
This PR updates the Voxtral README to document Metal backend support on
Apple Silicon.
@metascroy @GregoryComer
Update success-stories.md (pytorch#15309)
2e63fba 
Update unsloth QAT story to use qwen example, which has more details
than llama example.
@lucylq @GregoryComer
Add gemma to supported models (pytorch#15328)
5f6167f
@GregoryComer
Update build from source and getting started docs (pytorch#15311)
cb63da3 
### Summary

Update Getting Started and Build from Source Docs:
* Integrate Windows steps into the main flow with minor Windows-specific
callouts.
* Clarify top-level flow for building from source - add a table by use
case.
 * Clarify building ET as a submodule vs standalone build.
* Re-order, re-word, and clean up the content related to building from
source.
 * Add info on NDK build for Android.

Tracked in pytorch#14791 and
pytorch#14759.

cc @mergennachin @byjlw
@abhinaykukkadapu @GregoryComer
Fix more typos and broken links (pytorch#15331)
261eb2d
@GregoryComer
Update XNNPACK doc structure and add template (pytorch#14873)
14e19e8 
Prototype an updated doc structure for the XNNPACK backend. Extract a
common template out under docs/source/backends/tempate/

This PR updates the doc structure as follows. Under the template, the
landing page is required, partitioner, quantization, and op support docs
are recommended, and the rest are optional.

- XNNPACK Backend
   - Quantization (recommended)
   - Partitioner APIs (recommended)
   - Operator Support (optional)
   - Architecture and Internals (optional)
   - Tutorials (optional)
   - Guides (optional)
@psiddh @GregoryComer
Remove extra demo line from sucess-stories page (pytorch#15337)
571f925 
### Summary
[PLEASE REMOVE] See [CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests)
for ExecuTorch PR guidelines.

[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes
#<issue-id>` line.

[PLEASE REMOVE] If this PR introduces a fix or feature that should be
the upcoming release notes, please add a "Release notes: <area>" label.
For a list of available release notes labels, check out
[CONTRIBUTING.md's Pull
Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).

### Test plan
[PLEASE REMOVE] How did you test this PR? Please write down any manual
commands you used and note down tests that you have written if
applicable.
@GregoryComer GregoryComer requested a review from cccclai as a code owner October 22, 2025 00:53
@pytorch-bot
Copy link

pytorch-bot bot commented Oct 22, 2025 •
edited
Loading

🔗 Helpful Links

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

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

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

@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 Oct 22, 2025
@GregoryComer GregoryComer added the release notes: none Do not include this in the release notes label Oct 22, 2025
@psiddh psiddh self-requested a review October 22, 2025 00:58
psiddh
psiddh approved these changes Oct 22, 2025
View reviewed changes
Copy link
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.

Lets Go!

zonglinpeng and others added 2 commits October 21, 2025 18:04
@zonglinpeng @GregoryComer
update backend cadence md for branch cut (pytorch#15277)
5301a32 
Summary: ~

Differential Revision: D85064213
@GregoryComer
Minor doc fixes (pytorch#15336)
89b5071 
### Summary
Fix heading level for build verification, cleanup wording on Windows
reqs, update android presets since they were split by arch.
@GregoryComer GregoryComer merged commit 72d7ba8 into pytorch:release/1.0 Oct 22, 2025
119 of 124 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@psiddh psiddh psiddh approved these changes

@lucylq lucylq Awaiting requested review from lucylq lucylq is a code owner

@jackzhxng jackzhxng Awaiting requested review from jackzhxng jackzhxng is a code owner

@mergennachin mergennachin Awaiting requested review from mergennachin mergennachin is a code owner

@digantdesai digantdesai Awaiting requested review from digantdesai digantdesai is a code owner

@SS-JIA SS-JIA Awaiting requested review from SS-JIA SS-JIA is a code owner

@shoumikhin shoumikhin Awaiting requested review from shoumikhin shoumikhin is a code owner

@cccclai cccclai Awaiting requested review from cccclai cccclai is a code owner

Assignees

No one assigned

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. release notes: none Do not include this in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.