[winml] [P2] Multiple brand spellings in use (`WML`, `WinML`, `winml`, `Windows ML`, `ModelKit`) · Issue #510 · microsoft/winml-cli · GitHub
Skip to content

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

Description

@zhenchaoni

Severity: P2
Command: winml


Category: Naming Consistency — pick one canonical product name and use it everywhere.

Repro:

uv run winml --help
uv run winml --version
uv run winml export --help

Actual: Five different forms appear in user-visible output:

  • winml --help first line: WML ModelKit - Accelerate Model Deployment on WinML. (uses WML and WinML in the same sentence).
  • winml --version prints: winml, version 0.0.2 (lowercase winml).
  • winml export --help first line: Export HuggingFace model to ONNX format with HTP. (no brand).
  • winml inspect panel header reads WinML Inference Class.
  • winml sys table headers read Windows ML for the OS service and winml for the CLI.

Expected: Pick one canonical capitalization (e.g. WinML ModelKit for the product, winml only as the literal command name) and use it in every place a user can read it: top-level docstring, every subcommand docstring, --version output, every panel/table title, README.md, and pyproject.toml. Concretely:

  • Replace WML ModelKitWinML ModelKit in the top-level docstring.
  • Make winml --version print WinML ModelKit, version 0.0.2 (winml CLI).

Why it matters: Users searching docs/issues for the product name need one term. Marketing/legal usually require one canonical capitalization too.

Metadata

Metadata

Labels

P2Medium — minor bug or non-critical improvementbugSomething isn't workingdev experienceDeveloper experience improvementsqualityUse for quality control related issuestriagedIssue has been triaged

Type

Fields

No fields configured for Bug.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions