[docs] refactor: Organize model docs by family by yaoyu-33 · Pull Request #3908 · NVIDIA-NeMo/Megatron-Bridge

yaoyu-33 · 2026-05-20T22:21:24Z

Summary

Reorganized docs model pages from docs/models/llm and docs/models/vlm into docs/models// paths.
Replaced README and docs navigation category buckets with family-organized model tables and family index pages.
Updated cross-links from docs, examples, skills, and model comments to the new paths.

Validation

git diff --check
git diff --cached --check
git grep -n "docs/models/llm\|docs/models/vlm\|models/llm\|models/vlm\|Large Language Models\|Vision Language Models\|Omni Models"
- Only remaining hits are performance or paper-title prose outside the model collection.
git grep -n -i "brand" -- README.md docs examples skills src
- Only remaining hit is the FontAwesome icon class fa-brands fa-github.
uv run --no-sync pre-commit run --all-files

Unit tests were not run per request; this is a docs/navigation refactor.

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

copy-pr-bot · 2026-05-20T22:21:27Z

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.

yaoyu-33 · 2026-05-20T22:21:37Z

/ok to test 0964c9c

claude · 2026-05-20T22:25:52Z

Review - Clean docs-only refactor. All old docs/models/llm/ and docs/models/vlm/ references have been swept. No stale references remain in .md, .py, or .yaml files. Cross-links between model pages, examples, and skills are updated correctly. The Sphinx toctree in docs/index.md now lists brand index pages directly, which is consistent. Minor issue - README.md line 16 - The Nemotron-3 Nano Omni news entry text still says available on the nemotron_3_omni branch but the examples README link now points to main. Since the examples directory exists on main, the link is correct, but the surrounding prose is inconsistent. Consider updating the text to say the model is now available on main. This may be a pre-existing issue that this PR surfaced by fixing the link. Suggested test cases - No perf tests impacted.

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 · 2026-05-20T22:55:28Z

/ok to test e0ea428

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 · 2026-05-20T23:01:05Z

/ok to test 990003a

cuichenx · 2026-05-21T00:19:49Z

mistral and ministral is arguably the same family

Folded Ministral into the Mistral docs family: moved the Ministral 3 guide under docs/models/mistral/, removed the separate Ministral family index/toctree entry, and updated docs/example links so Ministral 3 remains discoverable under Mistral.

Follow-up addressed: moved the Ministral 3 examples from examples/models/ministral/ministral3 to examples/models/mistral/ministral3, removed the empty examples/models/ministral directory, and updated the README/docs/skill references to the new Mistral-family examples path.

cuichenx · 2026-05-21T00:21:35Z

+| **Nemotron** | [Nemotron H](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/nemotronh), [Nemotron Nano v2](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/nemotronh), [Nemotron-3 Nano](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/nemotronh), [Nemotron-3 Super](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/nemotronh), [Llama Nemotron](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/llama_nemotron), [Nemotron Nano v2 VL](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/nemotron_vl), [Nemotron-3 Nano Omni](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/nemotron_omni) | [Nemotron H recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/nemotronh/nemotronh.py), [Nemotron Nano v2 recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/nemotronh/nemotron_nano_v2.py), [Nemotron-3 Nano recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/nemotronh/nemotron_3_nano.py), [Nemotron-3 Super recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/nemotronh/nemotron_3_super.py), [Nemotron Nano v2 VL recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/nemotron_vl/nemotron_nano_v2_vl.py), [Nemotron-3 Nano Omni recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/nemotron_omni/nemotron_omni.py) |
+| **OLMoE** | [OLMoE](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/olmoe) | [recipes (7B)](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/olmoe/olmoe_7b.py) |
+| **Qwen** | [Qwen2 / Qwen2.5](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen), [Qwen3](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen), [Qwen3-MoE](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen), [Qwen3 Next](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen), [Qwen2.5-VL](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_vl), [Qwen3-VL](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_vl), [Qwen3.5-VL](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_vl), [Qwen3.6-VL](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_vl), [Qwen2 Audio](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_audio), [Qwen2.5-Omni](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_omni), [Qwen3-Omni](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen_omni), [Qwen3-ASR](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/qwen3_asr) | [Qwen2 recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/qwen/qwen2.py), [Qwen3 recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/qwen/qwen3.py), [Qwen3-MoE recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/qwen/qwen3_moe.py), [Qwen3 Next recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/qwen/qwen3_next.py), [Qwen VL recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/recipes/qwen_vl), [Qwen Omni recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/recipes/qwen_omni), [Qwen examples](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/examples/models/qwen) |
+| **Sarvam** | [Sarvam](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/sarvam) | [examples](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/examples/models/sarvam) |


should we link to the readme, if it exists? otherwise this table is a bit busy

Simplified the README supported-models table: variants are now plain text, and the resources column links to family docs plus README entry points where available instead of long per-recipe link lists. Also updated the Nemotron-3 Nano Omni news item to say the recipes are available on main.

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 · 2026-05-21T04:57:00Z

/ok to test dd91f2b

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 · 2026-05-21T21:03:55Z

/ok to test 4afcac2

cuichenx · 2026-05-21T22:23:56Z

+| **Mamba** | Mamba | [model bridge](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/mamba) |
+| **MiniMax** | MiniMax-M2 / M2.5 / M2.7 | [examples README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/minimax/minimax_m2/README.md) |
+| **Mistral** | Mistral, Ministral 3 (3B/8B/14B) | [model docs](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/mistral/index.md), [Ministral 3 examples README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/mistral/ministral3/README.md) |
+| **MiMo** | MiMo | [Megatron-MiMo training examples](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/examples/megatron_mimo) |


not megatron-mimo, xiaomi-mimo

Updated the README branding to Xiaomi-MiMo; the supported-models row now links to the new Xiaomi-MiMo docs page.

yaoyu-33 · 2026-05-22T00:44:35Z

+| **GPT-OSS** | GPT-oss | [model docs](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/gpt_oss/index.md), [examples README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/gpt_oss/README.md) |
+| **Kimi** | Kimi K2, Kimi-K2.5-VL | [Kimi-K2.5-VL examples README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/kimi/kimi_k25_vl/README.md) |
+| **Llama** | Llama 2, Llama 3 / 3.1 / 3.2 / 3.3 | [model docs](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/llama/index.md), [recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/recipes/llama) |
+| **Mamba** | Mamba | [model bridge](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/mamba) |


remove mamba

Removed Mamba from the README supported-models table.

yaoyu-33 · 2026-05-22T00:46:20Z

+| **Nemotron** | Nemotron H, Nemotron Nano v2, Nemotron-3 Nano, Nemotron-3 Super, Llama Nemotron, Nemotron Nano v2 VL, Nemotron-3 Nano Omni | [model docs](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/nemotron/index.md), [Nemotron-3 README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/nemotron/nemotron_3/README.md), [Nemotron-3 Omni README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/nemotron/nemotron_3_omni/README.md) |
+| **OLMoE** | OLMoE | [model docs](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/olmoe/index.md), [recipe](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/olmoe/olmoe_7b.py) |
+| **Qwen** | Qwen2 / Qwen2.5, Qwen3, Qwen3-MoE, Qwen3 Next, Qwen2.5-VL, Qwen3-VL, Qwen3.5-VL, Qwen3.6-VL, Qwen2 Audio, Qwen2.5-Omni, Qwen3-Omni, Qwen3-ASR | [model docs](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/qwen/index.md), [examples directory](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/examples/models/qwen) |
+| **Sarvam** | Sarvam | [examples README](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/examples/models/sarvam/README.md) |


we dont need last column. for hyperlink, just hyperlink the model doc hyperlink to model name

https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/docs/models/qwen/index.md to qwen.

If there is missing doc page for that model, please add in docs folder. Link the example directory in that model doc

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 · 2026-05-22T01:15:04Z

/ok to test b9619df

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Signed-off-by: Vasudevan Rengasamy <vrengasamy@nvidia.com>

[docs] refactor: Organize model docs by brand

0964c9c

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

copy-pr-bot Bot temporarily deployed to public May 20, 2026 22:22 Inactive

copy-pr-bot Bot temporarily deployed to test May 20, 2026 22:22 Inactive

copy-pr-bot Bot temporarily deployed to public May 20, 2026 22:29 Inactive

copy-pr-bot Bot temporarily deployed to public May 20, 2026 22:30 Inactive

[docs] fix README heading level

e0ea428

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

copy-pr-bot Bot temporarily deployed to public May 20, 2026 22:56 Inactive

copy-pr-bot Bot had a problem deploying to test May 20, 2026 22:56 Error

[docs] fix: Use family terminology for model docs

990003a

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 changed the title ~~[docs] refactor: Organize model docs by brand~~ [docs] refactor: Organize model docs by family May 20, 2026

copy-pr-bot Bot temporarily deployed to test May 20, 2026 23:01 Inactive

copy-pr-bot Bot temporarily deployed to public May 20, 2026 23:02 Inactive

yaoyu-33 added area:model Model implementations and HF bridge logic docs Documentation-only updates or documentation debt needs-review PR is ready for code review and waiting on a reviewer labels May 20, 2026

copy-pr-bot Bot temporarily deployed to public May 20, 2026 23:09 Inactive

copy-pr-bot Bot temporarily deployed to public May 20, 2026 23:10 Inactive

copy-pr-bot Bot temporarily deployed to public May 20, 2026 23:25 Inactive

yaoyu-33 added the docs-only With great power comes great responsibility. label May 21, 2026

cuichenx reviewed May 21, 2026

View reviewed changes

[docs] fix: Address model docs review comments

dd91f2b

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

yaoyu-33 removed the docs-only With great power comes great responsibility. label May 21, 2026

[docs] fix: Move Ministral examples under Mistral

4afcac2

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

copy-pr-bot Bot temporarily deployed to test May 21, 2026 21:04 Inactive

copy-pr-bot Bot temporarily deployed to public May 21, 2026 21:04 Inactive

copy-pr-bot Bot temporarily deployed to public May 21, 2026 21:12 Inactive

copy-pr-bot Bot temporarily deployed to public May 21, 2026 21:13 Inactive

copy-pr-bot Bot temporarily deployed to public May 21, 2026 21:30 Inactive

cuichenx reviewed May 21, 2026

View reviewed changes

yaoyu-33 commented May 22, 2026

View reviewed changes

[docs] fix: Simplify supported models table

b9619df

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>

copy-pr-bot Bot temporarily deployed to public May 22, 2026 01:15 Inactive

copy-pr-bot Bot temporarily deployed to test May 22, 2026 01:15 Inactive

yaoyu-33 added the docs-only With great power comes great responsibility. label May 22, 2026

copy-pr-bot Bot temporarily deployed to public May 22, 2026 01:23 Inactive

copy-pr-bot Bot temporarily deployed to public May 22, 2026 01:38 Inactive

yaoyu-33 removed the docs-only With great power comes great responsibility. label May 22, 2026

yaoyu-33 merged commit f19d8a9 into main May 22, 2026
101 checks passed

yaoyu-33 deleted the docs/model-collection-brand-layout branch May 22, 2026 04:38

yaoyu-33 mentioned this pull request May 22, 2026

[docs] docs: Add model variant pages #3930

Merged

cuichenx mentioned this pull request May 26, 2026

[NeMo FW 26.06 Release] MBridge v0.5.0 Roadmap #3754

Open

vasunvidia pushed a commit to vasunvidia/Megatron-Bridge that referenced this pull request Jun 10, 2026

[docs] refactor: Organize model docs by family (NVIDIA-NeMo#3908)

7c256b0

Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Signed-off-by: Vasudevan Rengasamy <vrengasamy@nvidia.com>

Conversation

yaoyu-33 commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

copy-pr-bot Bot commented May 20, 2026

Uh oh!

yaoyu-33 commented May 20, 2026

Uh oh!

claude Bot commented May 20, 2026

Uh oh!

yaoyu-33 commented May 20, 2026

Uh oh!

yaoyu-33 commented May 20, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yaoyu-33 commented May 21, 2026

Uh oh!

yaoyu-33 commented May 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yaoyu-33 May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yaoyu-33 commented May 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yaoyu-33 commented May 20, 2026 •

edited

Loading

yaoyu-33 May 22, 2026 •

edited

Loading