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

Populate "Using ExecuTorch on Android" doc page #8536

Open
GregoryComer opened this issue Feb 18, 2025 · 4 comments
Open

Populate "Using ExecuTorch on Android" doc page #8536

GregoryComer opened this issue Feb 18, 2025 · 4 comments
Assignees
Labels
module: android Issues related to Android code, build, and execution 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 18, 2025

📚 The doc issue

Note: This issue pertains to the executorch-just-works branch. It is intended to merge back into master within the next 1-2 weeks.

Populate the top-level Android docs under using-executorch-android.md. Top-level platform docs for runtime integration on Android. Focus on Java APIs and acquiring the ET libraries though Maven/Gradle. Cover library installation and runtime APIs for loading + running a model using Java runtime APIs. Briefly cover relevant delegates (XNN + Vulkan + NPU).

Placeholders and skeleton is added in #8511.

General documentation guidelines that I'm hoping to follow:

Suggest a potential alternative/fix

Updates

No response

cc @mergennachin @byjlw @kirklandsign @cbilgin

@GregoryComer GregoryComer added module: android Issues related to Android code, build, and execution 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 labels Feb 18, 2025
@github-project-automation github-project-automation bot moved this to To triage in ExecuTorch DevX Feb 18, 2025
@mergennachin mergennachin added this to the 0.6.0 milestone Feb 18, 2025
@mergennachin mergennachin moved this from To triage to Backlog in ExecuTorch DevX Feb 18, 2025
@mergennachin mergennachin moved this from Backlog to Ready in ExecuTorch DevX Feb 21, 2025
@mergennachin
Copy link
Contributor

This is a good issue to make sure user's issue is resolved in the doc

#8636

@kirklandsign
Copy link
Contributor

Per suggestion from discord, we need to note down how to load a model, what model can be loaded, how to infer during run-time, what input format should be, etc.

@mergennachin
Copy link
Contributor

Also #8665 is a relevant issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: android Issues related to Android code, build, and execution 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