Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -281,3 +281,12 @@ src/winml/modelkit/analyze/rules/runtime_check_rules/**/*.parquet
# Generated by mike (docs versioning)
docs/versions.json
/uv.lock

# An Agility SDK redist dropped where `winml cgc` looks for one, beside the venv
# or beside the installed package (see docs/commands/cgc.md). Multi-MB
# D3D12Core.dll: placed locally, never committed.
/bin/
/src/winml/bin/

# `winml cgc patterns --dump` writes into the working directory.
/patterns/
682 changes: 682 additions & 0 deletions docs/commands/cgc.md

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion docs/commands/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ shares a consistent invocation style — `winml <command> [flags]` — and the
same global flags are available on the root `winml` group.

The commands group by user intent. **Discover** (`sys`, `inspect`, `catalog`,
`analyze`) helps you understand your hardware and model before writing any
`cgc`, `analyze`) helps you understand your hardware and model before writing any
artifacts. **Configure** (`config`, `optimize`) produces a reusable build
configuration and tunes the ONNX graph. **Build** (`export`, `quantize`,
`compile`, `build`) runs the pipeline stages that produce deployment artifacts.
Expand All @@ -26,6 +26,7 @@ measure speed and accuracy.
| [`sys`](sys.md) | Discover | Inspect your machine — devices, EPs, and runtime versions at a glance. |
| [`inspect`](inspect.md) | Discover | Inspect a model's tasks, classes, and hierarchy before committing to an export. |
| [`catalog`](catalog.md) | Discover | Browse the curated winml-cli catalog of validated models and benchmarks. |
| [`cgc`](cgc.md) | Discover | Inspect D3D12 adapters and the MLIR patterns their drivers declare. |
| [`config`](config.md) | Configure | Generate a reusable build configuration for a Hugging Face model or ONNX file. |
| [`export`](export.md) | Build | Convert a PyTorch / Hugging Face model to ONNX, preserving module hierarchy. |
| [`analyze`](analyze.md) | Build | Verify an ONNX model is compatible with a target execution provider before deployment. |
Expand All @@ -41,6 +42,8 @@ measure speed and accuracy.
- **I want to see what hardware and EPs I have** → `winml sys`
- **I want to know if my model is supported** → `winml inspect`
- **I want to browse validated models with known benchmarks** → `winml catalog`
- **I want to know whether a GPU driver implements D3D MLIR programs** → `winml cgc adapters`
- **I want to see the MLIR patterns a GPU driver declares** → `winml cgc patterns`
- **I want to verify EP operator compatibility before compiling** → `winml analyze`
- **I want to convert a Hugging Face model to ONNX** → `winml export`
- **I want to run the whole pipeline in one go** → `winml build`
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ nav:
- sys: commands/sys.md
- inspect: commands/inspect.md
- catalog: commands/catalog.md
- cgc: commands/cgc.md
- Configure:
- config: commands/config.md
- Build:
Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,9 @@ where = [ "src" ]
include = [ "winml", "winml.*" ]

[tool.setuptools.package-data]
# The CGC pattern atlas is opened by `winml cgc patterns --open`, so it ships in
# the wheel. It is not a Python file, so packages.find never picks it up.
"winml.modelkit.commands" = [ "assets/*.html" ]
"winml.modelkit" = [ "py.typed" ]
"winml.modelkit.data" = [ "hub_models.json" ]
"winml.modelkit.analyze" = [
Expand Down
608 changes: 608 additions & 0 deletions src/winml/modelkit/commands/assets/cgc-pattern-atlas.html

Large diffs are not rendered by default.

Loading