Cleanup doc wording and code snippets in a few locations #8832
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8832
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
GregoryComer
added
module: doc
GregoryComer
force-pushed
the
doc-polish
branch
from
16a26fb to
2ba8c23
Compare
| model = MyModel() # The PyTorch model to export | ||
| example_inputs = (torch.randn(1,3,64,64),) # A tuple of inputs | ||
| model = models.mobilenetv2.mobilenet_v2(weights=MobileNet_V2_Weights.DEFAULT).eval() | ||
| sample_inputs = (torch.randn(1, 3, 224, 224), ) |
Contributor
There was a problem hiding this comment.
where is the actual export call?
exported_graph = torch.export.export(model, sample_inputs)
Member
Author
There was a problem hiding this comment.
It's actually inline in the to_edge_transform_and_lower call. I've been doing that for conciseness and have seen users doing this, but maybe it's better to break out?
Contributor
There was a problem hiding this comment.
Ah didn't see it somehow, maybe it's easy to miss.
yeah, at least for examples, and getting started, breaking out could be useful
mergennachin
approved these changes
Feb 28, 2025
Contributor
mergennachin
left a comment
mergennachin
left a comment
There was a problem hiding this comment.
See inline comments
GregoryComer
force-pushed
the
doc-polish
branch
from
2ba8c23 to
3b7c126
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR makes a few minor doc polish changes, such as moving system requirements above installation in getting started, cleaning up some code snippets, using MV2 for the getting started example, and some minor miscellaneous cleanup.
Test plan
Built docs locally to verify the content and formatting of changes.
cc @mergennachin @byjlw