Skip to content

docs(misc): list EXAONE, Kimi K3, MiniMax-M3 and Nemotron-3 Ultra as supported - #5743

Open
pruprakash wants to merge 1 commit into
mainfrom
pruprakash/fix_misc_readme_supported_models_coverage
Open

docs(misc): list EXAONE, Kimi K3, MiniMax-M3 and Nemotron-3 Ultra as supported#5743
pruprakash wants to merge 1 commit into
mainfrom
pruprakash/fix_misc_readme_supported_models_coverage

Conversation

@pruprakash

Copy link
Copy Markdown
Contributor

What does this PR do ?

Adds the four models a reader cannot find on the repository landing page: EXAONE, Kimi K3, MiniMax-M3 and Nemotron-3 Ultra ship on main with published docs pages, but the README Supported Models table names none of them.

Changelog

  • README.md: adds the EXAONE row linking docs/models/exaone/exaone.md; extends the Kimi, MiniMax and Nemotron rows with Kimi K3, MiniMax-M3 and Nemotron-3 Ultra.
  • tests/unit_tests/doc_consistency/test_readme_consistency.py: 2 stdlib-only tests comparing the table against docs/models/ and the tree behind it.

Additional Information

…supported

The README Supported Models table is hand-maintained while docs/models/ and
examples/ are updated by the PR that lands a model, so four families and
variants shipped on main were absent from the repository landing page.

Adds doc-consistency tests comparing the table against docs/models/ and the
tree behind it (red-green verified).

Detected by: megatron-bridge QA

Signed-off-by: Pruthviraj Prakash <pruprakash@nvidia.com>
@pruprakash pruprakash added docs Documentation-only updates or documentation debt area:misc Cross-cutting utilities, logging, helpers, and other changes needs-review PR is ready for code review and waiting on a reviewer qa_rcca_done labels Aug 22, 2026
@copy-pr-bot

copy-pr-bot Bot commented Aug 22, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@pruprakash pruprakash self-assigned this Aug 22, 2026
@claude

claude Bot commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Light review — LGTM

Docs-only + test-guard change. Verified against the working tree:

  • All four README additions are backed by shipped code and docs: EXAONE (docs/models/exaone/exaone.md, examples/models/exaone/), Kimi K3 (docs/models/kimi/kimi-k3.md), MiniMax-M3 (docs/models/minimax/minimax-m3.md), Nemotron-3 Ultra (docs/models/nemotron/nemotron3-ultra.md). Every README link target and every examples/... path referenced by these pages exists on disk.
  • The two new consistency tests iterate the entire docs/models tree, so they guard all families, not just the additions. I statically traced both across every family/variant page and README row: the family test finds no missing family, and the variant test matches every gated variant page (token-normalization handles nemotron3-ultra -> 'Nemotron-3 Ultra', minimax-m3 -> 'MiniMax-M3', kimi-k3 -> 'Kimi K3', etc.). Both pass.

Minor observation (non-blocking): the EXAONE row links to docs/models/exaone/exaone.md (a page) rather than an index.md like sibling families — fine, since _row_for_family matches on the docs/models/exaone/ prefix and the file exists.

Suggested test cases

  • tests/unit_tests/doc_consistency/test_readme_consistency.py::test_readme_supported_models_table_lists_every_shipped_model_family
  • tests/unit_tests/doc_consistency/test_readme_consistency.py::test_readme_supported_models_rows_name_every_shipped_model_variant
  • No perf tests impacted.

@pruprakash

Copy link
Copy Markdown
Contributor Author

/ok to test 0c18f77

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:misc Cross-cutting utilities, logging, helpers, and other changes docs Documentation-only updates or documentation debt needs-review PR is ready for code review and waiting on a reviewer qa_rcca_done

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant