Skip to content
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.

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

Create delegate documentation template #8269

Open
GregoryComer opened this issue Feb 6, 2025 · 1 comment
Open

Create delegate documentation template #8269

GregoryComer opened this issue Feb 6, 2025 · 1 comment
Assignees
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Milestone

Comments

@GregoryComer
Copy link
Member

GregoryComer commented Feb 6, 2025

📚 The doc issue

We need to improve the documentation for our delegates. Right now, information is sparse and it's difficult to find answers to common questions. We need to create a standard template for delegate documentation and then ensure that each delegate has a page in the docs under "Backend Delegates" based on this template.

Key information to cover includes:

  • System requirements, both for development and deployment - what hardware and software is supported? That may include iOS/Android versions, supported NPU hardware, microcontroller families, toolchains, and any other relevant requirements.
  • At a high level, what operators are well supported?
  • A code snippet / sample for export, including the relevant includes and usage of the partitioner. What partitioner options are there? For example, AOT compile for Core ML, or per-op mode for XNNPACK.
  • Runtime targets - what CMake target needs to be linked?
  • What quantization schemes and operators are supported?

Suggest a potential alternative/fix

No response

cc @mergennachin @byjlw

@GregoryComer GregoryComer added module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users labels Feb 6, 2025
@GregoryComer GregoryComer self-assigned this Feb 6, 2025
@github-project-automation github-project-automation bot moved this to To triage in ExecuTorch DevX Feb 6, 2025
@GregoryComer GregoryComer moved this from To triage to In progress in ExecuTorch DevX Feb 6, 2025
@mergennachin
Copy link
Contributor

Yeah, this is good, thanks

@mergennachin mergennachin added this to the 0.6.0 milestone Feb 6, 2025
@digantdesai digantdesai added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Feb 6, 2025
@mergennachin mergennachin moved this from In progress to Ready in ExecuTorch DevX Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
Status: Ready
Development

No branches or pull requests

3 participants