Skip to content

Commit 990003a

Browse files
committed
[docs] fix: Use family terminology for model docs
Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>
1 parent e0ea428 commit 990003a

5 files changed

Lines changed: 15 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ For a deeper dive into conversion design and advanced usage, see the [models REA
168168

169169
Megatron Bridge provides out-of-the-box bridges and training recipes for a wide range of models, built on top of base model architectures from [Megatron Core](https://github.com/NVIDIA/Megatron-LM/tree/main/megatron/core). Refer to the [models directory](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models) for the full list of model bridges.
170170

171-
| Brand / family | Supported variants | Recipes and examples |
171+
| Family | Supported variants | Recipes and examples |
172172
|----------------|--------------------|----------------------|
173173
| **Bailing** | [Ling 2.0 (Bailing)](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/bailing) | [examples](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/examples/models/bailing) |
174174
| **DeepSeek** | [DeepSeek V2 / V2 Lite](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/deepseek), [DeepSeek V3](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/deepseek), [DeepSeek V4](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/src/megatron/bridge/models/deepseek_v4) | [DeepSeek V2 recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/deepseek/deepseek_v2.py), [DeepSeek V3 recipes](https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/main/src/megatron/bridge/recipes/deepseek/deepseek_v3.py), [DeepSeek V4 examples](https://github.com/NVIDIA-NeMo/Megatron-Bridge/tree/main/examples/models/deepseek_v4) |

‎docs/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -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/README.md), organized by brand and model variant
19+
→ Browse [Supported Models](models/README.md), organized by family 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)
@@ -76,7 +76,7 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
7676

7777
| Document | Purpose | When to Read |
7878
|----------|---------|--------------|
79-
| **[Supported Models](models/README.md)** | Brand-organized model documentation | Working with supported model variants |
79+
| **[Supported Models](models/README.md)** | Family-organized model documentation | Working with supported model variants |
8080
| **[Adding New Models](adding-new-models.md)** | Guide for adding model support | Extending model support |
8181

8282
### Training and Customization
@@ -185,9 +185,9 @@ Welcome to the Megatron Bridge documentation! This guide helps you navigate our
185185

186186
#### [models/](models/README.md)
187187

188-
- Brand folders such as **[qwen/](models/qwen/index.md)**, **[gemma/](models/gemma/index.md)**, and **[nemotron/](models/nemotron/index.md)**
188+
- Family folders such as **[qwen/](models/qwen/index.md)**, **[gemma/](models/gemma/index.md)**, and **[nemotron/](models/nemotron/index.md)**
189189
- Model-variant guides for conversion, training recipes, and architecture notes
190-
- Multimodal variants live with their brand families
190+
- Multimodal variants live with their model families
191191

192192
#### [training/](training/README.md)
193193

@@ -235,7 +235,7 @@ graph TD
235235
I --> N[Data Parallelism<br/>DDP]
236236
I --> O[Model Parallelism<br/>TP/PP/VPP]
237237
238-
D --> P[Brand Index<br/>Model Variants]
238+
D --> P[Family Index<br/>Model Variants]
239239
D --> Q[Model Pages<br/>Recipes and Conversion]
240240
241241
style A fill:#e1f5fe

‎docs/models/README.md‎

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

3-
This directory contains brand-organized documentation for models supported by
3+
This directory contains family-organized documentation for models supported by
44
Megatron Bridge. Each model page covers supported variants, Hugging Face <->
55
Megatron Bridge conversion, training recipe links, and model-specific notes.
66

7-
## Brand Index
7+
## Family Index
88

9-
| Brand / family | Model documentation |
9+
| Family | Model documentation |
1010
|----------------|---------------------|
1111
| **DeepSeek** | [DeepSeek V2](deepseek/deepseek-v2.md), [DeepSeek V3](deepseek/deepseek-v3.md), [DeepSeek V4](deepseek/deepseek-v4.md) |
1212
| **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) |
@@ -25,7 +25,7 @@ Megatron Bridge conversion, training recipe links, and model-specific notes.
2525
### I want to
2626

2727
**Find model-specific docs**
28-
-> Browse the brand index above or use the navigation for the model's brand.
28+
-> Browse the family index above or use the navigation for the model's family.
2929

3030
**Convert models between formats**
3131
-> See [Bridge Guide](../bridge-guide.md) for Hugging Face <-> Megatron

‎skills/adding-model-support/SKILL.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,10 +343,10 @@ For detailed test patterns, see @skills/adding-model-support/tests-and-examples.
343343

344344
### Examples
345345

346-
Model examples: `examples/models/<brand>/<model>/`
346+
Model examples: `examples/models/<family>/<model>/`
347347

348348
```text
349-
examples/models/<brand>/<model>/
349+
examples/models/<family>/<model>/
350350
├── README.md
351351
├── conversion.sh # HF↔Megatron conversion commands (real model)
352352
├── inference.sh # Generation commands (real model, reasonable output)

‎skills/adding-model-support/tests-and-examples.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Example scripts target **real published models** (e.g. `Qwen/Qwen3-8B`), not toy
214214
The inference script must produce reasonable output — a coherent text completion for LLMs,
215215
a plausible image description for VLMs. This is the acceptance bar for the deliverable.
216216

217-
### Conversion example (`examples/models/<brand>/<model>/conversion.sh`)
217+
### Conversion example (`examples/models/<family>/<model>/conversion.sh`)
218218

219219
```bash
220220
#!/usr/bin/env bash
@@ -251,7 +251,7 @@ uv run python -m torch.distributed.run --nproc_per_node=8 \
251251
--hf-model-id ${HF_MODEL} --tp ${TP} --pp ${PP} --ep ${EP}
252252
```
253253

254-
### Inference example (`examples/models/<brand>/<model>/inference.sh`)
254+
### Inference example (`examples/models/<family>/<model>/inference.sh`)
255255

256256
For LLMs:
257257
```bash
@@ -323,7 +323,7 @@ uv run python examples/conversion/convert_checkpoints.py import \
323323

324324
## Training
325325

326-
See `examples/models/<brand>/<model>/slurm_sft.sh` and `slurm_peft.sh` for full Slurm scripts.
326+
See `examples/models/<family>/<model>/slurm_sft.sh` and `slurm_peft.sh` for full Slurm scripts.
327327
Single-node quick-start:
328328

329329
### SFT

0 commit comments

Comments
 (0)