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.

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

Re-write export tutorial / export getting started #8270

Closed
GregoryComer opened this issue Feb 6, 2025 · 3 comments
Closed

Re-write export tutorial / export getting started #8270

GregoryComer opened this issue Feb 6, 2025 · 3 comments
Assignees
@GregoryComer
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
0.6.0

Comments

@GregoryComer
Copy link
Member

GregoryComer commented Feb 6, 2025 •
edited by pytorch-bot bot
Loading

📚 The doc issue

Currently, the Getting Started doc flow points users to the Exporting to ExecuTorch Tutorial. While this page has a lot of key information, it is likely too low level for many users. We need to split it out into a true "Getting Started" and an advanced export / export reference page. The getting started doc should provide a concise description of how to export + lower for the most common use cases without getting too far into the weeds on IR, operator sets, and advanced use cases.

Ideally, this doc should cover:

  • End to end steps for exporting and lowering a model.
  • Specifying dynamic inputs (this needs to be in the getting started guide, as it's a very common trap for users).
  • Sanity checking the model using pybindings.

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
@GregoryComer GregoryComer moved this from In progress to Ready in ExecuTorch DevX Feb 6, 2025
@GregoryComer GregoryComer moved this from Ready to In progress in ExecuTorch DevX Feb 6, 2025
@mergennachin
Copy link
Contributor

Yeah, this is good!

@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
@digantdesai
Copy link
Contributor

Can we make sure the tutorial is in the CI?

@mergennachin mergennachin moved this from In progress to Ready in ExecuTorch DevX Feb 6, 2025
This was referenced Feb 11, 2025
Open
Open
@mergennachin
Copy link
Contributor

#8412

@mergennachin mergennachin moved this from Ready to In progress in ExecuTorch DevX Feb 18, 2025
@GregoryComer GregoryComer moved this from In progress to Done in ExecuTorch DevX Feb 18, 2025
@GregoryComer GregoryComer closed this as completed by moving to Done in ExecuTorch DevX Feb 18, 2025
This was referenced Feb 24, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GregoryComer GregoryComer

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
ExecuTorch DevX
Status: Done
Milestone
0.6.0
Development

No branches or pull requests
3 participants
@digantdesai @mergennachin @GregoryComer