Skip to content

Standardize WinML CLI naming across code and docs (#510)#1092

Open
ziyuanguo1998 wants to merge 2 commits into
mainfrom
ziyuan/standardize-winml-cli-naming
Open

Standardize WinML CLI naming across code and docs (#510)#1092
ziyuanguo1998 wants to merge 2 commits into
mainfrom
ziyuan/standardize-winml-cli-naming

Conversation

@ziyuanguo1998

Copy link
Copy Markdown
Contributor

Standardizes the product name to WinML CLI for #510, resolving the mixed user-facing spellings (winml CLI, Windows ML CLI).

Code (8b5e144)

  • Normalize lowercase winml CLI -> WinML CLI in command/serve/utils docstrings, scripts, the use-winml-cli skill, the serve static demo, and the test helper (15 spots).
  • Brand winml --version via prog_name (now WinML CLI, version X).
  • Replace the stale hardcoded ModelKit workspace-folder marker with winml-cli in analyze debug path normalization.

Docs (19e53bd)

  • Rename product display name Windows ML CLI -> WinML CLI across README, mkdocs site_name, and docs pages (index, ui-quickstart, supported-models).

Platform references (Windows ML) and the CLI command name (winml) are intentionally left unchanged.

Addresses #510.

- Normalize lowercase 'winml CLI' -> 'WinML CLI' across command/serve/utils docstrings, scripts, the use-winml-cli skill, the serve static demo, and the test helper (15 occurrences).
- Brand 'winml --version' output via prog_name (now 'WinML CLI, version X').
- Replace the stale hardcoded 'ModelKit' workspace-folder marker with 'winml-cli' in analyze debug path normalization.
- Standardize the product name to 'WinML CLI' across README, mkdocs site_name, and docs pages (index, ui-quickstart, supported-models).
- Platform references 'Windows ML' are left unchanged; generated PKG-INFO regenerates from README.
Comment thread src/winml/modelkit/cli.py
context_settings={"help_option_names": ["-h", "--help"]},
)
@click.version_option(version=__version__, prog_name="winml")
@click.version_option(version=__version__, prog_name="WinML CLI")

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.

incorrect

Comment thread README.md
[![Model Accuracy Report](https://img.shields.io/badge/docs-model%20accuracy%20report-blue)](https://microsoft.github.io/winml-cli/latest/reports/model_accuracy_report.html)

**Windows ML CLI** is a command line tool for building **portable, performant, and high-quality** AI models for Windows ML. It takes you from a source model — whether from Hugging Face or your own pipeline — to a hardware-optimized artifact in a reproducible workflow.
**WinML CLI** is a command line tool for building **portable, performant, and high-quality** AI models for Windows ML. It takes you from a source model — whether from Hugging Face or your own pipeline — to a hardware-optimized artifact in a reproducible workflow.

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.

as per windows ml doc guide, before first using winml, we should use windows ml to show that winml is its abbreviation

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