Skip to content

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

Merged
GregoryComer merged 7 commits into
pytorch:executorch-just-worksfrom
GregoryComer:doc-branch-cleanup
Feb 22, 2025
Merged

Clean up documentation placeholders and links, add top-level docs for C++ APIs, Android, and troubleshooting#8618
GregoryComer merged 7 commits into
pytorch:executorch-just-worksfrom
GregoryComer:doc-branch-cleanup

Conversation

@GregoryComer

@GregoryComerGregoryComer commented Feb 21, 2025

Copy link
Copy Markdown
Contributor

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.

@facebook-github-botfacebook-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 21, 2025
@pytorch-bot

pytorch-botBot commented Feb 21, 2025•
edited
Loading

Copy link
Copy Markdown

🔗 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 Failure

As of commit 198fecd 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.

@GregoryComer

GregoryComer commented Feb 21, 2025

Copy link
Copy Markdown
ContributorAuthor

@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
mergennachin requested changes Feb 21, 2025
View reviewed changes

@mergennachinmergennachin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threaddocs/source/getting-started.md Outdated
Comment threaddocs/source/getting-started.md
Comment threaddocs/source/getting-started.md Outdated
Comment threaddocs/source/using-executorch-cpp.md
Comment threaddocs/source/using-executorch-android.md
## 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.

@mergennachinmergennachinFeb 21, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kirklandsign

we need to populate this page soon.

Comment threaddocs/source/using-executorch-cpp.md
Comment threaddocs/source/index.rst
Comment threaddocs/source/using-executorch-troubleshooting.md Outdated
mergennachin
mergennachin approved these changes Feb 22, 2025
View reviewed changes

@mergennachinmergennachin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you

Comment threaddocs/source/getting-started.md
@@ -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 =

@mergennachinmergennachinFeb 22, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formatting still looks a bit off on the website

https://docs-preview.pytorch.org/pytorch/executorch/8618/getting-started.html

@GregoryComerGregoryComerFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#8637

@GregoryComer
GregoryComer merged commit 235f52d into pytorch:executorch-just-worksFeb 22, 2025
@GregoryComer

GregoryComer commented Feb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Completes #8534 and #8535.

GregoryComer added a commit to GregoryComer/executorch that referenced this pull request Feb 23, 2025
@GregoryComer
Clean up documentation placeholders and links, add top-level docs for…
68426c2
… 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
@GregoryComer
Clean up documentation placeholders and links, add top-level docs for…
be7d8e3
… 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
@GregoryComer
Clean up documentation placeholders and links, add top-level docs for…
0ae6d82
… 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
@GregoryComer
Merge updated documentation into master (#8638)
c6761f4
* 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mergennachinmergennachinmergennachin approved these changes
@byjlwbyjlwAwaiting requested review from byjlw

Assignees

No one assigned

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@GregoryComer@mergennachin@facebook-github-bot