Skip to content

Updating documentation for cmake dtype selective build #12112

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build #12112

merged 5 commits into from
Jun 30, 2025

Conversation

BujSet
Copy link
Contributor

@BujSet BujSet commented Jun 30, 2025 •
edited
Loading

Summary

Updating documentation for cmake dtype selective build with model API. Table at selective_build_model_doc/docs/source/kernel-library-selective-build.md now looks like:

image

Fixes #12065

cc @mergennachin @byjlw

@pytorch-bot PyTorch Bot
Copy link

pytorch-bot bot commented Jun 30, 2025 •
edited
Loading

🔗 Helpful Links

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

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

✅ No Failures

As of commit e9745f4 with merge base adb5318 (image):
💚 Looks good so far! There are no failures yet. 💚

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 Jun 30, 2025
@BujSet BujSet self-assigned this Jun 30, 2025
@BujSet BujSet added the module: doc Issues related to documentation, both in docs/ and inlined in code label Jun 30, 2025
@BujSet
Copy link
Contributor Author

BujSet commented Jun 30, 2025

@pytorchbot label "release notes: none"

@pytorch-bot pytorch-bot bot added the release notes: none Do not include this in the release notes label Jun 30, 2025
lucylq
lucylq reviewed Jun 30, 2025
View reviewed changes
@BujSet
Copy link
Contributor Author

BujSet commented Jun 30, 2025

cc @psiddh

@BujSet BujSet marked this pull request as ready for review June 30, 2025 18:37
JacobSzwejbka
JacobSzwejbka reviewed Jun 30, 2025
View reviewed changes
JacobSzwejbka
JacobSzwejbka reviewed Jun 30, 2025
View reviewed changes
JacobSzwejbka
JacobSzwejbka reviewed Jun 30, 2025
View reviewed changes
docs/source/kernel-library-selective-build.md

### Select ops from model

This API lets users pass in a pte file of an exported model. When used, the pte file will be parsed to generate a yaml file that enumerates the operators and dtypes used in the model.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the fact that a yaml file is generated relevant to the end user? The above documentation makes it seem like the model yaml is not a user facing construct, only the pte, or the root ops list are exposed methods of passing selective information.

Also in general I would say "root" ops is misleading since ET doesnt have transitive ops. We should just call it the op list.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When using the model API, the generated YAML can be as an input to the selective build process, like when using the yaml API directly. The difference being that a user doesn't have to manually craft a yaml, but can pass in a pte.

I agree, root ops is not a great name, but it seems to be used in other places as well, e.g. https://github.com/BujSet/executorch/blob/main/codegen/tools/gen_oplist.py#L234-L243. For consistency, I think we should keep it as root ops, and a separate PR should refactor this to something more meaningful, what do you think?

lucylq
lucylq reviewed Jun 30, 2025
View reviewed changes
@mergennachin mergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet BujSet force-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29 Compare June 30, 2025 19:37
@BujSet BujSet force-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4 Compare June 30, 2025 19:52
@BujSet BujSet merged commit f673a4b into pytorch:main Jun 30, 2025
102 checks passed
@mergennachin
Copy link
Contributor

@lucylq @BujSet @larryliu0820 should this part of the cherry-pick for 0.7?

@lucylq
Copy link
Contributor

lucylq commented Jun 30, 2025

@lucylq @BujSet @larryliu0820 should this part of the cherry-pick for 0.7?

Yes, I think we can include it as all the code changes are there. @BujSet could you cherry-pick it following the instructions in #11075 ?

@BujSet
Copy link
Contributor Author

BujSet commented Jun 30, 2025

@pytorchbot cherry-pick --onto release/0.7 -c docs

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
@BujSet @pytorchbot
Updating documentation for cmake dtype selective build (#12112)
a7c2549 
### Summary
Updating documentation for cmake dtype selective build with model API.
Table at
`selective_build_model_doc/docs/source/kernel-library-selective-build.md`
now looks like:

![image](https://github.com/user-attachments/assets/68b7c8fe-dfc5-4ae4-9756-5599680357bf)

Fixes #12065

cc @mergennachin @byjlw

(cherry picked from commit f673a4b)
@pytorchbot
Copy link
Collaborator

Cherry picking #12112

The cherry pick PR is at #12123 The following tracker issues are updated:

Details for Dev Infra team Raised by workflow job

@pytorchbot pytorchbot mentioned this pull request Jun 30, 2025
Closed
@BujSet BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
@lucylq lucylq mentioned this pull request Jul 3, 2025
Open
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
@BujSet @Tanish2101
Updating documentation for cmake dtype selective build (pytorch#12112)
c5cfad7 
Updating documentation for cmake dtype selective build with model API.
Table at
`selective_build_model_doc/docs/source/kernel-library-selective-build.md`
now looks like:

![image](https://github.com/user-attachments/assets/68b7c8fe-dfc5-4ae4-9756-5599680357bf)

Fixes pytorch#12065

cc @mergennachin @byjlw
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JacobSzwejbka JacobSzwejbka JacobSzwejbka left review comments

@lucylq lucylq lucylq approved these changes

@larryliu0820 larryliu0820 Awaiting requested review from larryliu0820 larryliu0820 is a code owner

@mergennachin mergennachin Awaiting requested review from mergennachin mergennachin is a code owner

Assignees

@BujSet BujSet

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: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) release notes: none Do not include this in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update documentation for cmake selective build features

6 participants

@BujSet @mergennachin @lucylq @pytorchbot @JacobSzwejbka @facebook-github-bot