Skip to content

Added docs for setting up executorch on windows #11273

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
merged 5 commits into from
Jun 4, 2025

Conversation

nil-is-all
Copy link
Contributor

Summary

First documentation for setting up ExecuTorch for Windows and exporting MobileNet V2 model and executing.
This version works only on Windows Powershell on admin mode.

Copy link

pytorch-bot bot commented May 30, 2025

🔗 Helpful Links

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

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

✅ You can merge normally! (1 Unrelated Failure)

As of commit 21e2e99 with merge base ceaf147 (image):

FLAKY - The following job failed but was likely due to flakiness present on trunk:

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 May 30, 2025
@nil-is-all
Copy link
Contributor Author

@pytorchbot label "release notes: none"

@pytorch-bot pytorch-bot bot added the release notes: none Do not include this in the release notes label May 30, 2025
@nil-is-all nil-is-all marked this pull request as ready for review June 2, 2025 15:03
@nil-is-all nil-is-all requested a review from mergennachin as a code owner June 2, 2025 15:03
@nil-is-all
Copy link
Contributor Author

@GregoryComer @SS-JIA Feel free to tag anyone else as well to help review this draft on Windows Doc

@mergennachin mergennachin requested a review from GregoryComer June 2, 2025 15:11
@mergennachin
Copy link
Contributor

mergennachin commented Jun 2, 2025

Why is this a completely different page?

Can we do cards where you can toggle between different codeblocks based on platform

See https://docs.pytorch.org/torchrec/setup-torchrec.html#installation as an example where you can toggle based (pypi, nightly, build from source)

cc @GregoryComer

Copy link
Contributor

@SS-JIA SS-JIA left a comment

Choose a reason for hiding this comment

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

Awesome stuff!

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.

See my previous comment

cc @SS-JIA

@GregoryComer
Copy link
Member

Why is this a completely different page?

Can we do cards where you can toggle between different codeblocks based on platform

See https://docs.pytorch.org/torchrec/setup-torchrec.html#installation as an example where you can toggle based (pypi, nightly, build from source)

cc @GregoryComer

@nil-is-all I'll defer to Mergen's preference on where to put this. Can you take a look at trying to integrate into the existing Building from Source page? The code is in using-executorch-building-from-source.md.

We can probably just add a Windows section initially, and we can look at maybe integrating sphinx-tabs or something eventually. There's enough Windows specific steps that I'm fine with having a dedicated windows heading for now.

1) Changed MV2 intro to "uses the MobileNet v2 model to classify images." since current runner doesn't have camera integration
2) reworded conda env setup
3) added escape character for backslashes
4) mentioned MV2 model output values represent class scores
@nil-is-all
Copy link
Contributor Author

@GregoryComer I reflected the smaller edits you mentioned. Will work on integrating into the Building from Source page as a section.

Added as a section in using-executorch-building-from-source.md
@nil-is-all
Copy link
Contributor Author

@mergennachin, @GregoryComer Added as a section under using-executorch-building-from-source.md
Do let me know if this edit works, with respect to formatting especially.

@GregoryComer GregoryComer merged commit bca2cf5 into pytorch:main Jun 4, 2025
95 of 96 checks passed
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. release notes: none Do not include this in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants