Skip to content

doc: add Windows ML CLI build flow section to model conversion#9874

Merged
ntrogh merged 7 commits into
microsoft:mainfrom
ssss141414:shzhen/winml-ui-modelconversion-update
Jun 3, 2026
Merged

doc: add Windows ML CLI build flow section to model conversion#9874
ntrogh merged 7 commits into
microsoft:mainfrom
ssss141414:shzhen/winml-ui-modelconversion-update

Conversation

@ssss141414

Copy link
Copy Markdown
Contributor

No description provided.

Comment thread docs/intelligentapps/modelconversion.md Outdated
Comment thread docs/intelligentapps/modelconversion.md Outdated
Comment thread docs/intelligentapps/modelconversion.md Outdated
Comment thread docs/intelligentapps/modelconversion.md Outdated
Comment thread docs/intelligentapps/modelconversion.md Outdated
Comment thread docs/intelligentapps/modelconversion.md
Comment thread docs/intelligentapps/modelconversion.md
Comment thread docs/intelligentapps/modelconversion.md Outdated

The behavior on first entry depends on how the model was added to the project:

- **Built-in models** (the curated entries that already have a model card) ship with a prepared configuration. The Build Flow card opens directly in the **Configured** state — no auto-configuration runs. Select **Edit Config** to review the prepared recipe, then select **Build**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Built-in models already include validated configurations for WinML CLI workflows.
These curated models ship with prepared Build Config files optimized for Windows ML EPs.

Comment thread docs/intelligentapps/modelconversion.md Outdated
The behavior on first entry depends on how the model was added to the project:

- **Built-in models** (the curated entries that already have a model card) ship with a prepared configuration. The Build Flow card opens directly in the **Configured** state — no auto-configuration runs. Select **Edit Config** to review the prepared recipe, then select **Build**.
- **Hugging Face models added by ID** are downloaded and analyzed automatically on first entry. The card transitions through these states:

@hi-brenda hi-brenda Jun 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Step 1: Generate the build config
Hugging Face models added by ID are automatically processed on first entry.
WinML CLI queries Hugging Face, auto-detects the task and model type, and generates Build Config JSON files automatically.
During onboarding, WinML CLI generates three configuration variants:

config-noquant.json
config-w8a16.json
config-w8a8.json

The primary difference between them is the quantization strategy:

No Quant — full precision model
W8A16 — 8-bit weights with 16-bit activations
W8A8 — 8-bit weights with 8-bit activations for more aggressive compression and performance optimization

Step 2: Customize the Config
You can customize the workflow before running the build pipeline.
Typical customization areas include: Task type, compile target, precision details.
By default, Compile is set to null.
You can customize the Compile with target EP, e.g. xxxx.

Step 3: Run the build
This build runs all four pipeline stages in sequence:

  1. Export
  2. Optimize
  3. Quantize
  4. Compile
    The workflow reads the settings recorded in config*.json.
    After the build step, WinML CLI automatically generates a declarative build_config.json file that defines how the workflow runs end-to-end. Developers can inspect and customize it through View Config.
    This declarative configuration model makes it easy to integrate WinML CLI into CI/CD pipelines with reproducible and portable build workflows.

WinML CLI also generates an analyze report, which can be viewed through View Analyze.
The analyze results provide detailed model compatibility insights, including:
supported operators, partially supported operators, unsupported operators for Windows ML EPs.
During analysis, WinML CLI automatically inspects the ONNX graph, detects optimization patterns, and generates recommended Windows ML optimization workflows.

Comment thread docs/intelligentapps/modelconversion.md

@hi-brenda hi-brenda left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

more comments

ntrogh
ntrogh previously approved these changes Jun 3, 2026

@ntrogh ntrogh left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@ssss141414 Let me know when this can be merged

@ssss141414

Copy link
Copy Markdown
Contributor Author

@ssss141414 Let me know when this can be merged

Sure. In discussion with our PM. Will inform you when ready. Thank you!

aeschli
aeschli previously approved these changes Jun 3, 2026
Comment thread docs/intelligentapps/modelconversion.md Outdated

@hi-brenda hi-brenda left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

minor change

alexr00
alexr00 previously approved these changes Jun 3, 2026
@ssss141414 ssss141414 dismissed stale reviews from alexr00 and aeschli via d9c01a2 June 3, 2026 14:29
@ntrogh ntrogh merged commit 4db4414 into microsoft:main Jun 3, 2026
1 of 2 checks passed
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.

5 participants