microsoft / microsoft/winml-cli
Auto-generate supported-models.md catalog tables from hub_models.json
Open
@DingmaomaoBJTU is already working on this.
Since Jun 22, 2026.
documentation
P2
triaged
- Dominant language
- Python
- Stars
- 40
- Forks
- 11
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 50
Description
When hub_models.json is updated, the catalog tables in docs/reference/supported-models.md should be automatically regenerated rather than manually maintained.
Proposal
Add a script (e.g. scripts/generate_supported_models_doc.py) that:
- Reads
src/winml/modelkit/data/hub_models.json - Groups models by task and generates the markdown tables
- Updates
docs/reference/supported-models.mdin-place (preserving the header and non-generated sections)
This could also be integrated into CI to verify the doc stays in sync with the JSON data.
Context
From PR #912 review discussion — @xieofxie suggested using a script so the doc is automatically updated whenever hub_models.json changes.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.