Skip to content

[ET-VK][docs] Update to the new template #14996

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
merged 1 commit into from
Oct 18, 2025
Merged

[ET-VK][docs] Update to the new template #14996

merged 1 commit into from
Oct 18, 2025

Conversation

SS-JIA
Copy link
Contributor

@SS-JIA SS-JIA commented Oct 10, 2025 •
edited
Loading

No description provided.

This was referenced Oct 10, 2025
Closed
Closed
@pytorch-bot PyTorch Bot
Copy link

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

🔗 Helpful Links

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

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

❌ 1 New Failure, 99 Pending

As of commit e323c8b with merge base c016f29 (image):

NEW FAILURE - The following job has failed:

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 10, 2025
@github-actions GitHub Actions
Copy link

This PR needs a release notes: label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

@SS-JIA SS-JIA changed the base branch from main to pr14995 October 10, 2025 17:30
@SS-JIA SS-JIA changed the base branch from pr14995 to main October 10, 2025 17:31
@SS-JIA SS-JIA changed the base branch from main to pr14995 October 10, 2025 17:32
@SS-JIA SS-JIA changed the base branch from pr14995 to main October 10, 2025 18:06
@SS-JIA SS-JIA changed the base branch from main to pr14995 October 10, 2025 18:09
@digantdesai
Copy link
Contributor

docs are not rendered :(

@SS-JIA SS-JIA changed the base branch from pr14995 to main October 15, 2025 17:52
abhinaykukkadapu
abhinaykukkadapu reviewed Oct 17, 2025
View reviewed changes
docs/source/backends/vulkan/vulkan-overview.md

## Development Requirements

To contribute to the Vulkan delegate, the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home#android)
Copy link
Contributor

Choose a reason for hiding this comment

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

As i'm installing the sdk, needed to figure out that i need to run setup-env.sh, for someone who is dealing this for the first time, it might not be obvious, do you think we can add this to instructions here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will do...

GregoryComer
GregoryComer approved these changes Oct 17, 2025
View reviewed changes
Copy link
Member

@GregoryComer GregoryComer left a comment

Choose a reason for hiding this comment

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

Thanks. This looks great.

docs/source/backends/vulkan/tutorials/etvk-llama-tutorial.md
cmake --build cmake-out-android-so -j16 --target install --config Release
```

## Build and push the llama runner binary to Android
Copy link
Member

Choose a reason for hiding this comment

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

Is it worth mentioning the Java APIs and AAR? It doesn't require build from source and is likely closer to the more common user flow. Though if you feel it's out of scope for this tutorial, feel free to ignore this comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The target audience for this page in my mind is more for developers - for running it in an app, I think the docs/tutorials for the demo app would be more apprioriate. I can add a link to it here though so folks don't get confused 👍

docs/source/backends/vulkan/vulkan-overview.md Outdated

To run the model on-device, use the standard ExecuTorch runtime APIs.

The Vulkan delegate is included by default in the published Android packages.
Copy link
Member

Choose a reason for hiding this comment

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

Can you mention that it's in the executorch-android-vulkan package, specifically? https://mvnrepository.com/artifact/org.pytorch/executorch-android-vulkan. I believe the main executorch-android doesn't include it (though maybe it should?).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point!

@GregoryComer
Copy link
Member

I don't see the sub-pages for Vulkan showing up in the rendered docs here: https://docs-preview.pytorch.org/pytorch/executorch/14996/backends-vulkan.html. I do see the TOC in vulkan-overview.md, so maybe the rendered version is out of date. Do you see the sub-pages locally?

@SS-JIA SS-JIA force-pushed the pr14996 branch 4 times, most recently from 60c9a01 to a08fcba Compare October 17, 2025 23:25
@SS-JIA SS-JIA merged commit dbdeb49 into main Oct 18, 2025
131 of 162 checks passed
@SS-JIA SS-JIA deleted the pr14996 branch October 18, 2025 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@abhinaykukkadapu abhinaykukkadapu abhinaykukkadapu left review comments

@GregoryComer GregoryComer GregoryComer approved these changes

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

@digantdesai digantdesai Awaiting requested review from digantdesai

@larryliu0820 larryliu0820 Awaiting requested review from larryliu0820

@kirklandsign kirklandsign Awaiting requested review from kirklandsign

@swolchok swolchok Awaiting requested review from swolchok

@JacobSzwejbka JacobSzwejbka Awaiting requested review from JacobSzwejbka

@lucylq lucylq Awaiting requested review from lucylq

@kimishpatel kimishpatel Awaiting requested review from kimishpatel

@shoumikhin shoumikhin Awaiting requested review from shoumikhin

@jackzhxng jackzhxng Awaiting requested review from jackzhxng

@robert-kalmar robert-kalmar Awaiting requested review from robert-kalmar

@cccclai cccclai Awaiting requested review from cccclai

@Gasoonjia Gasoonjia Awaiting requested review from Gasoonjia

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.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@SS-JIA @digantdesai @GregoryComer @abhinaykukkadapu