Skip to content

[0.6 documentation] Developer Tools: Bundled Program #10193

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
Closed
zhenyan-zhang-meta opened this issue Apr 15, 2025 · 0 comments
Closed

[0.6 documentation] Developer Tools: Bundled Program #10193

zhenyan-zhang-meta opened this issue Apr 15, 2025 · 0 comments
Assignees
@zhenyan-zhang-meta
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@zhenyan-zhang-meta
Copy link
Contributor

📚 The doc issue

Emit Stage

  • In Step 1: The hyperlink of “Generate Sample ExecuTorch program” needs to be updated, since “getting started” is revamped.
  • In sample code
    • UserWarning: Attempted to insert a get_attr Node with no underlying reference in the owning GraphModule! Call GraphModule.add_submodule to add the necessary submodule, GraphModule.add_parameter to add the necessary Parameter, or nn.Module.register_buffer to add the necessary buffer
    • to_edge -> to_edge_transform_and_lower, as updated in https://pytorch.org/executorch/0.6/getting-started.html

Runtime stage

  • Functions not found: get_program_data, load_bundled_input, load_bundled_output
Image

cc @byjlw @Gasoonjia @metascroy @mergennachin

Suggest a potential alternative/fix

Wrote inline, self-assigned for a fix.
@zhenyan-zhang-meta zhenyan-zhang-meta self-assigned this Apr 15, 2025
@zhenyan-zhang-meta zhenyan-zhang-meta added module: doc Issues related to documentation, both in docs/ and inlined in code triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Apr 15, 2025
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 15, 2025
[0.6 documentation] Fix Page Developer Tools: Bundled Program
7d67133 
#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

[ghstack-poisoned]
@zhenyan-zhang-meta zhenyan-zhang-meta mentioned this issue Apr 15, 2025
Merged
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 15, 2025
[0.6 documentation] Fix Page Developer Tools: Bundled Program
195da7e 
#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

ghstack-source-id: 278155699
Pull Request resolved: #10194
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 16, 2025
Update base for Update on "[0.6 documentation] Fix Page Developer Too…
08bd201 
…ls: Bundled Program"

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

[ghstack-poisoned]
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 16, 2025
Update on "[0.6 documentation] Fix Page Developer Tools: Bundled Prog…
0299a71 
…ram"

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

[ghstack-poisoned]
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 16, 2025
[0.6 documentation] Fix Page Developer Tools: Bundled Program
986bde7 
Pull Request resolved: #10194

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.
ghstack-source-id: 278357457
@exported-using-ghexport

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 16, 2025
Update base for Update on "[0.6 documentation] Fix Page Developer Too…
2ebd013 
…ls: Bundled Program"

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

[ghstack-poisoned]
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 16, 2025
Update on "[0.6 documentation] Fix Page Developer Tools: Bundled Prog…
e4dd23a 
…ram"

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

[ghstack-poisoned]
zhenyan-zhang-meta pushed a commit that referenced this issue Apr 16, 2025
[0.6 documentation] Fix Page Developer Tools: Bundled Program
039eea8 
Pull Request resolved: #10194

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this part has been heavily revamped in v0.6:
  - Update to https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
  - Update `to_edge` to be `to_edge_transform_and_lower`, as updated in https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input` and `load_bundled_output`, as there are no other similar usage in the doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
  - For runtime example, change to a ready-to-use snippet for people to quickly try out.
ghstack-source-id: 278385371
@exported-using-ghexport

Differential Revision: [D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)
zhenyan-zhang-meta added a commit that referenced this issue Apr 16, 2025
@zhenyan-zhang-meta
[0.6 documentation] Fix Page Developer Tools: Bundled Program (#10194)
32abec5 
Stack from [ghstack](https://github.com/ezyang/ghstack) (oldest at
bottom):
* __->__ #10194

#10193

- Update the hyperlink of “Generate Sample ExecuTorch program”, as this
part has been heavily revamped in v0.6:
- Update to
https://pytorch.org/executorch/0.6/getting-started.html#exporting
- Fixed the emit stage sample code:
  - Use `register_buffer` as warning suggests.
- Update `to_edge` to be `to_edge_transform_and_lower`, as updated in
https://pytorch.org/executorch/0.6/getting-started.html.
- Remove function blocks for `get_program_data`, `load_bundled_input`
and `load_bundled_output`, as there are no other similar usage in the
doc.
  - Changed to links of real-world examples.
- Remove hard-coded cpp code examples.
  - For APIs, provide links to real-world examples.
- For runtime example, change to a ready-to-use snippet for people to
quickly try out.

Differential Revision:
[D73027728](https://our.internmc.facebook.com/intern/diff/D73027728/)

Co-authored-by: zhenyanzhang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zhenyan-zhang-meta zhenyan-zhang-meta

Labels
module: doc Issues related to documentation, both in docs/ and inlined in code triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zhenyan-zhang-meta