Skip to content

Auto-generate supported-models.md catalog tables from hub_models.json #917

Description

@DingmaomaoBJTU

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:

  1. Reads src/winml/modelkit/data/hub_models.json
  2. Groups models by task and generates the markdown tables
  3. Updates docs/reference/supported-models.md in-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.

Metadata

Metadata

Labels

P2Medium — minor bug or non-critical improvementdocumentationImprovements or additions to documentationtriagedIssue has been triaged

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions