Skip to content

Commit 0964c9c

Browse files
committed
[docs] refactor: Organize model docs by brand
Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>
1 parent f4b705a commit 0964c9c

57 files changed

Lines changed: 279 additions & 461 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 22 additions & 57 deletions
Large diffs are not rendered by default.

‎docs/README.md‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Megatron Bridge Documentation
22

3-
Welcome to the Megatron Bridge documentation! This guide helps you navigate our comprehensive documentation to find exactly what you need for training, converting, and working with large language models and vision language models.
3+
Welcome to the Megatron Bridge documentation! This guide helps you navigate our comprehensive documentation to find exactly what you need for training, converting, and working with language, vision-language, audio, and multimodal models.
44

55
## 🚀 Quick Start Paths
66

@@ -16,7 +16,7 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
1616
→ See [Training Documentation](training/README.md) for comprehensive training guides
1717

1818
**📚 Find model documentation**
19-
→ Browse [Supported Models](models/llm/index.md) for LLMs or [Vision Language Models](models/vlm/index.md) for VLMs
19+
→ Browse [Supported Models](models/README.md), organized by brand and model variant
2020

2121
**🔧 Migrate from NeMo 2 or Megatron-LM**
2222
→ Check [NeMo 2 Migration Guide](nemo2-migration-guide.md) or [Megatron-LM Migration Guide](megatron-lm-to-megatron-bridge.md)
@@ -38,7 +38,7 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
3838

3939
- **Start here:** [Bridge Guide](bridge-guide.md) → [Training Documentation](training/README.md)
4040
- **Deep dive:** [Performance Guide](performance-guide.md) → [Training Optimization Guides](training/README.md#optimization-and-performance)
41-
- **Model support:** [Supported Models](models/llm/index.md) → [Adding New Models](adding-new-models.md)
41+
- **Model support:** [Supported Models](models/README.md) → [Adding New Models](adding-new-models.md)
4242

4343
### For Training Engineers
4444

@@ -49,7 +49,7 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
4949
### For Model Developers
5050

5151
- **Start here:** [Bridge Guide](bridge-guide.md) → [Bridge Tech Details](bridge-tech-details.md)
52-
- **Model support:** [Adding New Models](adding-new-models.md) → [Model Documentation](models/llm/index.md)
52+
- **Model support:** [Adding New Models](adding-new-models.md) → [Model Documentation](models/README.md)
5353
- **Integration:** [Bridge RL Integration](bridge-rl-integration.md)
5454

5555
### For DevOps & Platform Teams
@@ -76,8 +76,7 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
7676

7777
| Document | Purpose | When to Read |
7878
|----------|---------|--------------|
79-
| **[Large Language Models](models/llm/index.md)** | LLM model documentation | Working with LLM models |
80-
| **[Vision Language Models](models/vlm/index.md)** | VLM model documentation | Working with VLM models |
79+
| **[Supported Models](models/README.md)** | Brand-organized model documentation | Working with supported model variants |
8180
| **[Adding New Models](adding-new-models.md)** | Guide for adding model support | Extending model support |
8281

8382
### Training and Customization
@@ -149,7 +148,7 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
149148

150149
1. [Bridge Guide](bridge-guide.md) *(conversion basics)*
151150
2. [Bridge Tech Details](bridge-tech-details.md) *(technical details)*
152-
3. [Supported Models](models/llm/index.md) or [Vision Language Models](models/vlm/index.md) *(model-specific guides)*
151+
3. [Supported Models](models/README.md) *(model-specific guides)*
153152
4. [Adding New Models](adding-new-models.md) *(extend support)*
154153

155154
### 🔧 Customization and Extension
@@ -186,12 +185,9 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
186185

187186
#### [models/](models/README.md)
188187

189-
- **[llm/](models/llm/README.md)** - Large Language Model documentation
190-
- Individual model guides (Qwen, LLaMA, Mistral, etc.)
191-
- Conversion examples and training recipes
192-
- **[vlm/](models/vlm/README.md)** - Vision Language Model documentation
193-
- VLM model guides (Qwen VL, Gemma VL, etc.)
194-
- Multimodal model support
188+
- Brand folders such as **[qwen/](models/qwen/index.md)**, **[gemma/](models/gemma/index.md)**, and **[nemotron/](models/nemotron/index.md)**
189+
- Model-variant guides for conversion, training recipes, and architecture notes
190+
- Multimodal variants live with their brand families
195191

196192
#### [training/](training/README.md)
197193

@@ -239,8 +235,8 @@ graph TD
239235
I --> N[Data Parallelism<br/>DDP]
240236
I --> O[Model Parallelism<br/>TP/PP/VPP]
241237
242-
D --> P[LLM Models<br/>Language Models]
243-
D --> Q[VLM Models<br/>Vision Language Models]
238+
D --> P[Brand Index<br/>Model Variants]
239+
D --> Q[Model Pages<br/>Recipes and Conversion]
244240
245241
style A fill:#e1f5fe
246242
style B fill:#f3e5f5

‎docs/index.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,18 @@ bridge-tech-details.md
3333
:caption: Supported Models
3434
:hidden:
3535
36-
models/llm/index.md
37-
models/vlm/index.md
36+
models/README.md
37+
models/deepseek/index.md
38+
models/gemma/index.md
39+
models/glm/index.md
40+
models/gpt_oss/index.md
41+
models/llama/index.md
42+
models/ministral/index.md
43+
models/mistral/index.md
44+
models/moonlight/index.md
45+
models/nemotron/index.md
46+
models/olmoe/index.md
47+
models/qwen/index.md
3848
```
3949

4050
```{toctree}
@@ -106,9 +116,6 @@ skills-index
106116
:hidden:
107117
108118
README.md
109-
models/README.md
110-
models/llm/README.md
111-
models/vlm/README.md
112119
releases/README.md
113120
training/README.md
114121
modelopt/README.md

‎docs/models/README.md‎

Lines changed: 42 additions & 196 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,42 @@
11
# Supported Models
22

3-
This directory contains documentation for all models supported by Megatron Bridge, including Large Language Models (LLMs) and Vision Language Models (VLMs). Each model documentation includes architecture details, conversion examples for Hugging Face ↔ Megatron Bridge, and links to training recipes.
4-
5-
## Model Categories
6-
7-
Megatron Bridge supports two main categories of models:
8-
9-
### 🔤 Large Language Models (LLMs)
10-
11-
Text-only models for language understanding and generation tasks.
12-
13-
| Category | Model Count | Documentation |
14-
|----------|-------------|---------------|
15-
| **Large Language Models** | 13 models | [LLM Documentation](llm/README.md) |
16-
17-
**Supported LLM Families:**
18-
19-
- DeepSeek (V2, V3)
20-
- Gemma (2, 3)
21-
- GLM-4.5
22-
- GPT-OSS
23-
- LLaMA (3, Nemotron)
24-
- Mistral
25-
- Moonlight
26-
- Nemotron-H
27-
- OLMoE
28-
- Qwen (2, 2.5, 3, 3 MoE, 3-Next)
29-
30-
### 🖼️ Vision Language Models (VLMs)
31-
32-
Multimodal models that combine vision and language capabilities.
33-
34-
| Category | Model Count | Documentation |
35-
|----------|-------------|---------------|
36-
| **Vision Language Models** | 5 models | [VLM Documentation](vlm/README.md) |
37-
38-
**Supported VLM Families:**
39-
40-
- Gemma 3 VL
41-
- Nemotron-3 Nano Omni (image + video + audio + text)
42-
- Nemotron Nano V2 VL
43-
- Qwen (2.5 VL, 3 VL)
44-
45-
---
3+
This directory contains brand-organized documentation for models supported by
4+
Megatron Bridge. Each model page covers supported variants, Hugging Face <->
5+
Megatron Bridge conversion, training recipe links, and model-specific notes.
6+
7+
## Brand Index
8+
9+
| Brand / family | Model documentation |
10+
|----------------|---------------------|
11+
| **DeepSeek** | [DeepSeek V2](deepseek/deepseek-v2.md), [DeepSeek V3](deepseek/deepseek-v3.md), [DeepSeek V4](deepseek/deepseek-v4.md) |
12+
| **Gemma** | [Gemma 2](gemma/gemma2.md), [Gemma 3](gemma/gemma3.md), [Gemma 3 VL](gemma/gemma3-vl.md), [Gemma 4 VL](gemma/gemma4-vl.md) |
13+
| **GLM** | [GLM 4.5](glm/glm45.md), [GLM-4.5V](glm/glm-45v.md) |
14+
| **GPT-OSS** | [GPT OSS](gpt_oss/gpt-oss.md) |
15+
| **Llama** | [Llama 3](llama/llama3.md) |
16+
| **Ministral** | [Ministral 3](ministral/ministral3.md) |
17+
| **Mistral** | [Mistral](mistral/mistral.md) |
18+
| **Moonlight** | [Moonlight](moonlight/moonlight.md) |
19+
| **Nemotron** | [Llama Nemotron](nemotron/llama-nemotron.md), [Nemotron H and Nemotron Nano v2](nemotron/nemotronh.md), [Nemotron-3 Nano](nemotron/nemotron3-nano.md), [Nemotron-3 Super](nemotron/nemotron3-super.md), [Nemotron Nano V2 VL](nemotron/nemotron-nano-v2-vl.md), [Nemotron-3 Nano Omni](nemotron/nemotron-3-omni.md) |
20+
| **OLMoE** | [OLMoE](olmoe/olmoe.md) |
21+
| **Qwen** | [Qwen](qwen/qwen.md), [Qwen2.5-VL](qwen/qwen2.5-vl.md), [Qwen3-VL](qwen/qwen3-vl.md), [Qwen3.5 / 3.6](qwen/qwen35-vl.md), [Qwen3-Omni](qwen/qwen3-omni.md) |
4622

4723
## Quick Navigation
4824

4925
### I want to
5026

51-
**🔍 Find a specific LLM model**
52-
→ Browse [Large Language Models](llm/README.md) documentation
53-
54-
**🖼️ Find a specific VLM model**
55-
→ Browse [Vision Language Models](vlm/README.md) documentation
56-
57-
**🔄 Convert models between formats**
58-
→ See [Bridge Guide](../bridge-guide.md) for Hugging Face ↔ Megatron conversion
59-
60-
**🚀 Get started with training**
61-
→ See [Training Documentation](../training/README.md) for training guides
27+
**Find model-specific docs**
28+
-> Browse the brand index above or use the navigation for the model's brand.
6229

63-
**📚 Understand model architectures**
64-
→ Each model page documents architecture-specific features and configurations
30+
**Convert models between formats**
31+
-> See [Bridge Guide](../bridge-guide.md) for Hugging Face <-> Megatron
32+
conversion basics. Model pages include model-specific commands where available.
6533

66-
**🔧 Add support for a new model**
67-
→ Refer to [Adding New Models](../adding-new-models.md)
34+
**Get started with training**
35+
-> See [Training Documentation](../training/README.md) for training guides and
36+
[Recipe Usage](../recipe-usage.md) for pre-configured training recipes.
6837

69-
**📊 Use training recipes**
70-
→ Read [Recipe Usage](../recipe-usage.md) for pre-configured training recipes
71-
72-
---
38+
**Add support for a new model**
39+
-> Refer to [Adding New Models](../adding-new-models.md).
7340

7441
## Model Documentation Structure
7542

@@ -81,147 +48,35 @@ Each model documentation page typically includes:
8148
4. **Training Recipes** - Links to training configurations and examples
8249
5. **Architecture Details** - Model-specific features and configurations
8350

84-
---
85-
86-
## Common Tasks by Model Type
87-
88-
### For LLM Models
89-
90-
**Training:**
91-
92-
- Pretraining on large corpora
93-
- Supervised fine-tuning (SFT)
94-
- Parameter-efficient fine-tuning (PEFT/LoRA)
95-
- Preference optimization (DPO)
96-
97-
**Deployment:**
98-
99-
- Export to Hugging Face format
100-
- Integration with inference engines
101-
- Model serving and deployment
102-
103-
**Use Cases:**
104-
105-
- Text generation
106-
- Question answering
107-
- Conversational AI
108-
- Code generation
109-
110-
### For VLM Models
111-
112-
**Training:**
113-
114-
- Multimodal pretraining
115-
- Vision-language alignment
116-
- Fine-tuning on visual tasks
117-
118-
**Deployment:**
51+
## Model Support Overview
11952

120-
- Export to Hugging Face format
121-
- Multimodal inference
53+
### Decoder-Only and Hybrid Backbones
12254

123-
**Use Cases:**
55+
- DeepSeek, Gemma, GLM, GPT-OSS, Llama, Mistral, Moonlight, Nemotron, OLMoE, and Qwen
56+
- MoE and hybrid variants including DeepSeek, GLM, GPT-OSS, Nemotron-3, OLMoE, Qwen3-MoE, and Qwen3-Next
12457

125-
- Image captioning
126-
- Visual question answering
127-
- Document understanding
128-
- Multimodal reasoning
58+
### Multimodal Variants
12959

130-
---
60+
- Gemma 3 VL and Gemma 4 VL
61+
- GLM-4.5V
62+
- Nemotron Nano V2 VL and Nemotron-3 Nano Omni
63+
- Qwen2.5-VL, Qwen3-VL, Qwen3.5 / 3.6, and Qwen3-Omni
13164

13265
## Related Documentation
13366

134-
### Getting Started
135-
13667
- **[Main Documentation](../README.md)** - Return to main documentation
137-
- **[Bridge Guide](../bridge-guide.md)** - Hugging Face ↔ Megatron conversion
68+
- **[Bridge Guide](../bridge-guide.md)** - Hugging Face <-> Megatron conversion
13869
- **[Bridge Tech Details](../bridge-tech-details.md)** - Technical details of the bridge system
139-
140-
### Training Resources
141-
14270
- **[Training Documentation](../training/README.md)** - Comprehensive training guides
143-
- **[Configuration Container](../training/config-container-overview.md)** - Training configuration
144-
- **[Parallelisms Guide](../parallelisms.md)** - Data and model parallelism strategies
145-
- **[Performance Guide](../performance-guide.md)** - Performance optimization
146-
147-
### Advanced Topics
148-
14971
- **[Adding New Models](../adding-new-models.md)** - Extending model support
15072
- **[Recipe Usage](../recipe-usage.md)** - Using pre-configured training recipes
151-
- **[Bridge RL Integration](../bridge-rl-integration.md)** - Reinforcement learning integration
152-
- **[PEFT](../training/peft.md)** - Parameter-efficient fine-tuning
153-
154-
---
155-
156-
## Model Support Overview
157-
158-
### By Architecture Type
159-
160-
**Decoder-Only (Autoregressive):**
161-
162-
- GPT-style models (GPT-OSS)
163-
- LLaMA family (LLaMA 3, LLaMA Nemotron)
164-
- Qwen family (Qwen 2, 2.5, 3, 3-Next)
165-
- Gemma family (Gemma 2, 3)
166-
- DeepSeek family (DeepSeek V2, V3)
167-
- Mistral, Moonlight, Nemotron-H, GLM-4.5
168-
169-
**Mixture-of-Experts (MoE):**
170-
171-
- Qwen 3 MoE, Qwen 3-Next
172-
- DeepSeek V2, V3
173-
- OLMoE
174-
175-
**Vision-Language (Multimodal):**
176-
177-
- Gemma 3 VL
178-
- Qwen 2.5 VL, Qwen 3 VL
179-
- Nemotron Nano V2 VL
180-
- Nemotron-3 Nano Omni
181-
182-
### By Provider
183-
184-
**Meta/LLaMA:**
185-
186-
- LLaMA 3
187-
188-
**NVIDIA:**
189-
190-
- LLaMA Nemotron
191-
- Nemotron-H
192-
- Nemotron Nano V2 VL
193-
- Nemotron-3 Nano Omni
194-
195-
**Alibaba Cloud:**
196-
197-
- Qwen (2, 2.5, 3, 3 MoE, 3-Next)
198-
- Qwen VL (2.5, 3)
199-
200-
**Google:**
201-
202-
- Gemma (2, 3)
203-
- Gemma 3 VL
204-
205-
**DeepSeek:**
206-
207-
- DeepSeek (V2, V3)
208-
209-
**Other:**
210-
211-
- Mistral AI (Mistral)
212-
- GLM-4.5
213-
- GPT-OSS
214-
- Moonlight
215-
- OLMoE
216-
217-
---
21873

21974
## Conversion Support
22075

221-
All models support bidirectional conversion:
76+
All model pages document support for one or both conversion directions:
22277

223-
- **Hugging Face → Megatron Bridge**: Load pretrained weights for training
224-
- **Megatron Bridge → Hugging Face**: Export trained models for deployment
78+
- **Hugging Face -> Megatron Bridge**: Load pretrained weights for training
79+
- **Megatron Bridge -> Hugging Face**: Export trained models for deployment
22580

22681
Conversion features:
22782

@@ -231,12 +86,3 @@ Conversion features:
23186
- Verification mechanisms for conversion accuracy
23287

23388
Refer to the [Bridge Guide](../bridge-guide.md) for detailed conversion instructions.
234-
235-
---
236-
237-
**Ready to explore?** Choose a model category:
238-
239-
- [Large Language Models (LLMs)](llm/README.md)
240-
- [Vision Language Models (VLMs)](vlm/README.md)
241-
242-
Or return to the [main documentation](../README.md).
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)