docs: clarify --ep vs --optimize in getting-started guide - #201
Merged
Conversation
Add comprehensive documentation for --ep (recommended) and --optimize (manual) CLI flags. Explain when to use each, with examples for all supported EPs. Note that --ep affects graph construction while --optimize is post-hoc only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Justin Chu <justinchu@microsoft.com>
Performance Comparison
|
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Justin Chu <justinchu@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the getting-started guide to better explain CLI build-time optimization knobs, especially the difference between targeting an execution provider (--ep) vs manually applying rewrite rules (--optimize).
Changes:
- Updates the quick-start CLI example to use
--ep cuda --dtype f16instead of--optimize. - Expands CLI reference docs with
--ep,--runtime, and a dedicated--epvs--optimizesection. - Adds
mobius list epsto the CLI discovery commands list.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Justin Chu <justinchu@microsoft.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improve the CLI documentation in
docs/getting-started.md:--ep(recommended): Full EP-aware pipeline — graph construction, operator fusion, dead input removal, KV cache sizing. Examples for all 6 EPs (cpu, cuda, dml, webgpu, trt-rtx, onnx-standard).--optimize(manual): Post-hoc rewrite rule application. Useful for experimentation. Does not affect graph construction.Clear note that the two cannot be combined and
--epis strictly more capable.Added
mobius list epsto the CLI reference.Updated the quick-start example to use
--ep cuda --dtype f16instead of--optimize.