Skip to content

Update comments in getting-started.md for clarity - #202

Merged
justinchuby merged 1 commit into
mainfrom
justinchuby-patch-1
Apr 23, 2026
Merged

Update comments in getting-started.md for clarity#202
justinchuby merged 1 commit into
mainfrom
justinchuby-patch-1

Conversation

@justinchuby

Copy link
Copy Markdown
Member

No description provided.

Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
@justinchuby
justinchuby requested review from a team and Copilot April 23, 2026 20:30
@justinchuby
justinchuby merged commit ea8251a into main Apr 23, 2026
13 of 14 checks passed
@justinchuby
justinchuby deleted the justinchuby-patch-1 branch April 23, 2026 20:30
@github-actions

Copy link
Copy Markdown

Performance Comparison

Comparing 2e9111104f380b

Model Metric Baseline Current Delta
bert (feature-extraction) model_size_bytes 359 KB 359 KB +0.0%
bert (feature-extraction) num_nodes 60 60 +0.0%
falcon model_size_bytes 364 KB 364 KB +0.0%
falcon num_nodes 66 66 +0.0%
gemma2 model_size_bytes 428 KB 428 KB +0.0%
gemma2 num_nodes 107 107 +0.0%
gpt2 model_size_bytes 388 KB 388 KB +0.0%
gpt2 num_nodes 53 53 +0.0%
llama model_size_bytes 425 KB 425 KB +0.0%
llama num_nodes 61 61 +0.0%
llama (static-cache) model_size_bytes 425 KB 425 KB +0.0%
llama (static-cache) num_nodes 58 58 +0.0%
mamba (ssm-text-generation) model_size_bytes 296 KB 296 KB +0.0%
mamba (ssm-text-generation) num_nodes 98 98 +0.0%
phi3 model_size_bytes 421 KB 421 KB +0.0%
phi3 num_nodes 59 59 +0.0%
phi3 (static-cache) model_size_bytes 421 KB 421 KB +0.0%
phi3 (static-cache) num_nodes 56 56 +0.0%
qwen2 model_size_bytes 425 KB 425 KB +0.0%
qwen2 num_nodes 61 61 +0.0%
qwen2 (static-cache) model_size_bytes 425 KB 425 KB +0.0%
qwen2 (static-cache) num_nodes 58 58 +0.0%
qwen3_5_moe (hybrid-text-generation) model_size_bytes 506 KB 506 KB +0.0%
qwen3_5_moe (hybrid-text-generation) num_nodes 275 275 +0.0%
qwen3_5_text (hybrid-text-generation) model_size_bytes 458 KB 458 KB +0.0%
qwen3_5_text (hybrid-text-generation) num_nodes 129 129 +0.0%
qwen3_5_vl (hybrid-qwen-vl) model_size_bytes 977 KB 977 KB +0.0%
qwen3_5_vl (hybrid-qwen-vl) num_nodes 408 408 +0.0%
t5 (seq2seq) model_size_bytes 836 KB 836 KB +0.0%
t5 (seq2seq) num_nodes 166 166 +0.0%
whisper (speech-to-text) model_size_bytes 1008 KB 1008 KB +0.0%
whisper (speech-to-text) num_nodes 128 128 +0.0%

No performance regressions.

Copilot AI left a comment

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.

Pull request overview

Updates CLI example comments in the Getting Started guide to better describe the “default” and “onnx-standard” execution provider modes.

Changes:

  • Refines the “Default” mobius build comment to describe portability via local functions.
  • Shortens the “onnx-standard” mobius build comment to focus on “zero custom ops”.

Comment thread docs/getting-started.md

```bash
# Default (portable ONNX with standard fusions, no vendor-specific ops)
# Default (portable ONNX with standard fusions as model local functions)

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

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

The “Default” description here is potentially misleading: the default EP still applies fusions by emitting custom-domain ops (e.g., com.microsoft Skip* ops) with ONNX function bodies as a portable fallback. Consider rephrasing to explicitly mention “custom ops with ONNX function bodies/local functions” (or similar) so readers don’t interpret this as purely standard-ONNX nodes only.

Suggested change
# Default (portable ONNX with standard fusions as model local functions)
# Default (portable ONNX using custom fused ops with ONNX function bodies/local functions)

Copilot uses AI. Check for mistakes.
Comment thread docs/getting-started.md
mobius build --model meta-llama/Llama-3.2-1B output/ --ep webgpu --dtype f16

# Strict ONNX standard (zero custom ops, runs on any ONNX runtime)
# Strict ONNX standard (zero custom ops)

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

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

This “onnx-standard” description drops the key user-facing implication that the output should run on any conformant ONNX runtime without ORT extensions (matching the behavior described in src/mobius/_execution_providers.py). Consider adding that qualifier back (instead of just “zero custom ops”) to keep the guidance actionable.

Suggested change
# Strict ONNX standard (zero custom ops)
# Strict ONNX standard (runs on conformant ONNX runtimes without ORT
# extensions; zero custom ops)

Copilot uses AI. Check for mistakes.
@codecov

codecov Bot commented Apr 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants