-
Notifications
You must be signed in to change notification settings - Fork 457
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
Clean up a few more doc sections and links #8672
base: executorch-just-works
Are you sure you want to change the base?
Clean up a few more doc sections and links #8672
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8672
Note: Links to docs will display an error until the docs builds have been completed. ❌ 2 New FailuresAs of commit 7ee7942 with merge base 366d87e ( NEW FAILURES - The following jobs have failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
37b1ecc
to
7ee7942
Compare
|
||
## Runtime Integration | ||
|
||
To run the model on-device, use the standard ExecuTorch runtime APIs. See [Running on Device](getting-started.md#running-on-device) for more information. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this section, (maybe as a follow-up), please remember to add an example CMake file and c++ example runner code that uses XNNPACK (our current xnnpack_runner is too tied our repo, so not that one)
On top of that, we can also add to pytorch-labs/executorch-examples to showcase how it is used from out-of-tree repo.
Are the links fixed in https://github.com/pytorch/executorch/tree/executorch-just-works/examples/xnnpack? I think bunch of links that has "stable/..." will stop working on the next release I think it makes sense to move from hard-coded "stable/..." prefix to relative path, at least for the links you changed and modify the link name accordingly. There are a few https://github.com/search?q=repo%3Apytorch%2Fexecutorch%20stable%2F&type=code |
Good point on the stable docs. Those don't show up as warnings in the doc build, which I've been relying on to catch broken links. I'll see if I can replace all of the stable links with relative links. |
Summary
Clean up a few remaining placeholders, orphaned pages, and broken links.
Test plan
Built docs locally to verify changes.