Clean up documentation placeholders and links, add top-level docs for C++ APIs, Android, and troubleshooting #8618
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
facebook-github-bot
added
the
CLA Signed
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8618
Note: Links to docs will display an error until the docs builds have been completed. ❌ 1 New FailureAs of commit 198fecd with merge base 883ff14 ( NEW FAILURE - The following job has failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
@mergennachin This PR should hopefully clean up the executorch-just-works branch enough to merge it back into master today. I'll address any feedback you or anyone else leaves on this PR, and once merged, I'll open a follow-up to merge into master. |
mergennachin
requested changes
Feb 21, 2025
There was a problem hiding this comment.
Can you move some contents of the existing page (https://pytorch.org/executorch/stable/getting-started-setup.html#clone-and-install-executorch-requirements) to "Building from Source" page?
In particular, conda environment, ./install_executorch.sh etc
| @@ -4,7 +4,41 @@ To use from Android, ExecuTorch provides Java API bindings and Android platform | |||
|
|
|||
| ## Installation | |||
|
|
|||
| TODO Instructions on downloading the pre-built AAR. Replace with Maven/Gradle package management when available. | |||
| We provide two prebuilt Android libraries (AAR), `executorch.aar` for generic use case (image/audio processing) and `executorch_llama.aar` for LLAMA use case. | |||
There was a problem hiding this comment.
we need to populate this page soon.
mergennachin
approved these changes
Feb 22, 2025
| @@ -50,13 +52,13 @@ model = MyModel() # The PyTorch model to export | |||
| example_inputs = (torch.randn(1,3,64,64),) # A tuple of inputs | |||
|
|
|||
| et_program = | |||
There was a problem hiding this comment.
formatting still looks a bit off on the website
https://docs-preview.pytorch.org/pytorch/executorch/8618/getting-started.html
GregoryComer
merged commit 235f52d
into
pytorch:executorch-just-works
42 of 43 checks passed
GregoryComer
added a commit
to GregoryComer/executorch
that referenced
this pull request
Feb 23, 2025
… C++ APIs, Android, and troubleshooting (pytorch#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
GregoryComer
added a commit
that referenced
this pull request
Feb 23, 2025
… 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
GregoryComer
added a commit
that referenced
this pull request
Feb 26, 2025
… 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
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
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 cleans up and populates a few remaining placeholders in the new documentation flow, in preparation for merging back into the master branch. Specifically, I've cleaned up links across the getting started flow and populated the new Android, C++, and troubleshooting docs. These are not in a complete state yet, but are now reasonably populated, such that I believe we can move to working from master. For these documents, I've leaned heavily into the existing documentation.
Note that for the Android docs, we don't have a lot of the functionality in place yet (standalone AAR build, etc.), so I've left placeholder. I think this is fine for the nightly docs in the short-term. I've also removed references to Objective-C/Swift bindings, which we will replace once those are available.
Test plan
I have built the docs locally and verified the contents.