Skip to content

Add runtime integration documentation #8516

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

Merged

Conversation

GregoryComer
Copy link
Member

Summary

Add and populate a new doc page - Usage/Runtime Integration - to cover logging, selective build, and PAL overrides.

Test plan

Build docs locally to validate.

Copy link

pytorch-bot bot commented Feb 17, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8516

Note: Links to docs will display an error until the docs builds have been completed.

❌ 1 New Failure

As of commit 0bca031 with merge base 883ff14 (image):

NEW FAILURE - The following job has failed:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Feb 17, 2025
@GregoryComer
Copy link
Member Author

Note: I intend to add a diagram or otherwise try to break up the wall of text here. I'm mostly happy with the content as a draft, though.

@GregoryComer GregoryComer marked this pull request as ready for review February 17, 2025 10:18
@GregoryComer GregoryComer merged commit 7d12008 into pytorch:executorch-just-works Feb 18, 2025
42 of 43 checks passed
GregoryComer added a commit to GregoryComer/executorch that referenced this pull request Feb 23, 2025
GregoryComer added a commit that referenced this pull request Feb 23, 2025
GregoryComer added a commit that referenced this pull request Feb 26, 2025
GregoryComer added a commit that referenced this pull request Feb 26, 2025
* New Getting Started documentation (#8179)

WIP New getting started

* Update documentation flow and add placeholders (#8287)

Add placeholder top-level doc pages

* Add new export + lowering docs, update getting started (#8412)

Write new top-level export and lowering documentation

* More doc placeholders (#8523)

* Move cmake and faq docs to new location

* Rename CMake build to Building from Source

* Move backend docs to new locations (#8413)

* Temporarily remove new backend pages

* Move backend docs to new locations

* Update backend titles and inline contents

* Backend doc template (#8524)

Add backend template, update XNNPACK docs

* Add runtime integration documentation (#8516)

Add runtime integration doc

* Move iOS docs to top, add Android placeholders (#8511)

* Temporarily remove using-executorch-ios.md

* Move Apple runtime docs to new location

* Clean up documentation placeholders and links, add top-level docs for C++ APIs, Android, and troubleshooting (#8618)

* Clean up getting-started.md, remove placeholders

* Move Android pre-built AAR info into top-level Android page

* Add placeholder backend overview

* Add placeholder troubleshooting docs

* Populate top-level C++ API doc

* Clean up additional doc placeholders and fix broken links

* Add env setup instructions for source build

* Fix getting started code snippet (#8637)

Fix quotes in getting started code snippets

* Clean up a few more doc sections and links (#8672)

Clean up a few more broken links and sections in new doc flow

* Fix QNN link, typo (#8729)

* Add a CMake snippet to the XNNPACK backend doc build section (#8730)

Add CMake example to xnnpack backend doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants