Skip to content

Standardize product naming to "WinML CLI" (#510)#818

Open
ziyuanguo1998 wants to merge 1 commit into
mainfrom
ziyuan/standardize-product-naming
Open

Standardize product naming to "WinML CLI" (#510)#818
ziyuanguo1998 wants to merge 1 commit into
mainfrom
ziyuan/standardize-product-naming

Conversation

@ziyuanguo1998
Copy link
Copy Markdown
Contributor

Summary

Fixes #510 — multiple brand spellings (WML, WinML, winml, Windows ML) appeared inconsistently across user-visible output.

WML / WML ModelKit were already gone and the codebase had mostly standardized on WinML CLI. This PR finishes the job by enforcing one canonical scheme everywhere:

  • WinML CLI — the product/tool name
  • winml — the literal command
  • Windows ML — the OS platform models deploy to

Changes

User-visible

  • winml --version now prints WinML CLI, version 0.1.0 (was winml, version 0.1.0)
  • Top-level --help description uses Windows ML for the platform instead of bare WinML
  • pyproject.toml description → Accelerate Model Deployment on Windows ML
  • README.md lead-in **Windows ML CLI****WinML CLI** (matches the title)

Internal docstrings normalized (winml CLIWinML CLI): package __init__, command modules (analyze/compile/export/optimize/quantize), utils/console.py, and the serve module.

Test — added test_version_uses_canonical_product_name locking the canonical product name in --version output.

Left intentionally unchanged

  • Windows ML where it refers to the OS platform/runtime (banner subtitle, sys OS-service detection, device.py ORT-build comments, README platform descriptions)
  • WinML Inference Class — a technical term in inspect output

Note: the issue text suggested WinML ModelKit, but that predates the codebase's move to WinML CLI (banner art, package name, README title). Standardizing on WinML CLI is the smaller, against-the-grain-free change.

🤖 Generated with Claude Code

Pick one canonical scheme and apply it to every user-visible surface:
- "WinML CLI"   - the product/tool name
- "winml"       - the literal command
- "Windows ML"  - the OS platform models deploy to

Changes:
- winml --version now prints "WinML CLI, version X" (was "winml, version X")
- Top-level help description uses "Windows ML" for the platform instead of
  bare "WinML"
- pyproject description and README lead-in aligned to the scheme
- Normalize "winml CLI" -> "WinML CLI" in package/command/serve docstrings
- Add test locking the canonical product name in --version output

"Windows ML" is left intact where it refers to the OS platform/runtime, and
"WinML Inference Class" is kept as a technical term in inspect output.
@ziyuanguo1998 ziyuanguo1998 requested a review from a team as a code owner June 5, 2026 07:03
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.

[winml] [P2] Multiple brand spellings in use (WML, WinML, winml, Windows ML, ModelKit)

3 participants