Skip to content

Update Vulkan backend docs using backend template #8529

@GregoryComer

Description

@GregoryComer
Member

📚 The doc issue

Update the Vulkan backend top-level documentation page (docs/source/backends-coreml.md) to use the new backend template (docs/source/backend-template.md). See backend-xnnpack.md for an example. Feel free to deviate or suggest changes to the template if it does not make sense for this backend.

The template (docs/source/backend-template.md) includes the following information:

  • Delegate features
  • Development requirements
  • Target requirements
  • Partitioner API
  • Quantization
  • Runtime integration

General documentation guidelines that I'm hoping to follow:

Suggest a potential alternative/fix

No response

cc @mergennachin @byjlw @SS-JIA @manuelcandales @cbilgin

Activity

added
module: docIssues related to documentation, both in docs/ and inlined in code
module: vulkanIssues related to the Vulkan delegate and code under backends/vulkan/
triagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
on Feb 18, 2025
moved this from To triage to Backlog in ExecuTorch DevXon Feb 18, 2025
added this to the 0.6.0 milestone on Feb 18, 2025
GregoryComer

GregoryComer commented on Mar 19, 2025

@GregoryComer
MemberAuthor

@SS-JIA Hey Stephen, I've updated this task with a more detailed backend template and everything is merged back into master, so it should now be fully actionable. Could you take a look when you have time? It would be nice to have by 0.6 release (it can be picked), but 0.7 would be fine as well. Also, if you have any concerns with the doc approach, feel free to raise them. Thanks!

moved this from Backlog to Ready in ExecuTorch DevXon Mar 19, 2025
modified the milestones: 0.6.0, 1.0.0 on Aug 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

module: docIssues related to documentation, both in docs/ and inlined in codemodule: user experienceIssues related to reducing friction for usersmodule: vulkanIssues related to the Vulkan delegate and code under backends/vulkan/triagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

Status

Ready

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @mergennachin@SS-JIA@GregoryComer

      Issue actions

        Update Vulkan backend docs using backend template · Issue #8529 · pytorch/executorch