Skip to content

Conversation

@GregoryComer
Copy link
Member

@GregoryComer GregoryComer commented Oct 21, 2025

Summary

Update Getting Started and Build from Source Docs:

  • Integrate Windows steps into the main flow with minor Windows-specific callouts.
  • Clarify top-level flow for building from source - add a table by use case.
  • Clarify building ET as a submodule vs standalone build.
  • Re-order, re-word, and clean up the content related to building from source.
  • Add info on NDK build for Android.

Tracked in #14791 and #14759.

cc @mergennachin @byjlw

@pytorch-bot
Copy link

pytorch-bot bot commented Oct 21, 2025

🔗 Helpful Links

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

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

❌ 2 New Failures, 55 Pending

As of commit 8d9b821 with merge base fe3c1dc (image):

NEW FAILURES - The following jobs have failed:

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

@meta-cla meta-cla 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 Oct 21, 2025
@GregoryComer GregoryComer requested a review from psiddh October 21, 2025 18:20
@GregoryComer GregoryComer added module: doc Issues related to documentation, both in docs/ and inlined in code release notes: none Do not include this in the release notes labels Oct 21, 2025
@GregoryComer GregoryComer force-pushed the build-source-docs-update branch from 5260ced to 38fa8ba Compare October 21, 2025 20:25
Copy link
Contributor

@mergennachin mergennachin left a comment

Choose a reason for hiding this comment

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

I see that you removed but I recommend adding back a brief "Verify Your Build" section after the Building section that contains

  • One-line command to export a simple model
  • One-line command to run it with the executor_runner

@GregoryComer
Copy link
Member Author

I see that you removed but I recommend adding back a brief "Verify Your Build" section after the Building section that contains

  • One-line command to export a simple model
  • One-line command to run it with the executor_runner

Sounds good. I'll re-add. The reason I removed it was partly because we don't actually build the executor_runner for most presets and it requires multiple CLI options to include. I'm a little conflicted on this, but maybe we should build by default?

I think it does make sense to have a quick verification step. I'll re-add.

@GregoryComer GregoryComer force-pushed the build-source-docs-update branch from 38fa8ba to 8d9b821 Compare October 21, 2025 22:32
@GregoryComer
Copy link
Member Author

I see that you removed but I recommend adding back a brief "Verify Your Build" section after the Building section that contains

  • One-line command to export a simple model
  • One-line command to run it with the executor_runner

Sounds good. I'll re-add. The reason I removed it was partly because we don't actually build the executor_runner for most presets and it requires multiple CLI options to include. I'm a little conflicted on this, but maybe we should build by default?

I think it does make sense to have a quick verification step. I'll re-add.

Added.

@GregoryComer GregoryComer merged commit e22c6ed into pytorch:main Oct 21, 2025
129 of 139 checks passed
GregoryComer added a commit to GregoryComer/executorch that referenced this pull request Oct 22, 2025
### Summary

Update Getting Started and Build from Source Docs:
* Integrate Windows steps into the main flow with minor Windows-specific
callouts.
* Clarify top-level flow for building from source - add a table by use
case.
 * Clarify building ET as a submodule vs standalone build.
* Re-order, re-word, and clean up the content related to building from
source.
 * Add info on NDK build for Android.

Tracked in pytorch#14791 and
pytorch#14759.

cc @mergennachin @byjlw
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. module: doc Issues related to documentation, both in docs/ and inlined in code release notes: none Do not include this in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants