Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Updating documentation for cmake dtype selective build - #12112

Merged
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc
Jun 30, 2025
Merged

Updating documentation for cmake dtype selective build#12112
BujSet merged 5 commits into
pytorch:mainfrom
BujSet:selective_build_model_doc

Conversation

@BujSet

@BujSetBujSet commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

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-botBot commented Jun 30, 2025

Copy link
Copy Markdown

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

Copy link
Copy Markdown
ContributorAuthor

@pytorchbot label "release notes: none"

@pytorch-botpytorch-botBot added the release notes: none Do not include this in the release notes label Jun 30, 2025
Comment threadexamples/selective_build/README.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threaddocs/source/kernel-library-selective-build.md Outdated
Comment threadexamples/selective_build/README.md
@BujSet

Copy link
Copy Markdown
ContributorAuthor

cc @psiddh

@BujSet
BujSet marked this pull request as ready for review June 30, 2025 18:37
Comment threaddocs/source/kernel-library-selective-build.md
Comment threaddocs/source/kernel-library-selective-build.md Outdated

### 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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/source/kernel-library-selective-build.md Outdated
@mergennachinmergennachin added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jun 30, 2025
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from a6f2443 to 8da8a29CompareJune 30, 2025 19:37
@BujSet
BujSetforce-pushed the selective_build_model_doc branch from 8da8a29 to e9745f4CompareJune 30, 2025 19:52
@BujSet
BujSet merged commit f673a4b into pytorch:mainJun 30, 2025
@mergennachin

Copy link
Copy Markdown
Contributor

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

@lucylq

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
ContributorAuthor

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

pytorchbot pushed a commit that referenced this pull request Jun 30, 2025
### 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
Copy Markdown
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

@pytorchbotpytorchbot mentioned this pull request Jun 30, 2025
@BujSet
BujSet deleted the selective_build_model_doc branch July 3, 2025 14:01
Tanish2101 pushed a commit to Tanish2101/executorch that referenced this pull request Jul 9, 2025
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)
Fixespytorch#12065
cc @mergennachin@byjlw
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.module: docIssues related to documentation, both in docs/ and inlined in coderelease notes: apiChanges to public facing apis (any interfaces, pybinded runtime methods, etc.)release notes: noneDo not include this in the release notes

Projects

None yet

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