Skip to content
This repository was archived by the owner on May 20, 2026. It is now read-only.

Commit b60a7d5

Browse files
committed
docs: readme simple init formatting
Signed-off-by: Lawrence Lane <llane@nvidia.com>
1 parent 2eb57c2 commit b60a7d5

6 files changed

Lines changed: 78 additions & 8 deletions

File tree

examples/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1-
# Examples
1+
# DFM Examples
22

3-
Training and inference examples for dtensor and megatron models
3+
Collection of examples and recipes for training and inference using the Data Foundation Model (DFM) framework.
4+
5+
## Quick Start
6+
7+
If you are new to DFM, start with the **[Automodel Examples](automodel/)** for high-level API usage.
8+
9+
## Examples by Category
10+
11+
| Category | Description | Key Examples |
12+
|----------|-------------|--------------|
13+
| **[Automodel](automodel/)** | High-level API for seamless training and inference | [Wan 2.1 Fine-tuning](automodel/README.md), [Pretraining](automodel/pretrain/), [Generation](automodel/generate/) |
14+
| **[Megatron](megatron/)** | Advanced recipes and configurations using Megatron-Core | [DiT Recipes](megatron/recipes/dit/), [Wan Recipes](megatron/recipes/wan/) |
15+
16+
## Support
17+
18+
For issues or questions, please open a GitHub issue or refer to the main documentation.

examples/automodel/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Automodel Examples
2+
3+
High-level API examples for training, fine-tuning, and generating with DFM models.
4+
5+
## Directory Structure
6+
7+
| Directory | Description |
8+
|-----------|-------------|
9+
| **[finetune](finetune/)** | Scripts and configs for fine-tuning models |
10+
| **[generate](generate/)** | Inference and validation scripts |
11+
| **[pretrain](pretrain/)** | Pre-training workflows |
12+
13+
---
14+
115
# Diffusion Model Fine-tuning with Automodel Backend
216

317
Train diffusion models with distributed training support using NeMo Automodel and flow matching.
@@ -219,7 +233,7 @@ fsdp:
219233
## Features
220234

221235
- ✅ **Flow Matching**: Pure flow matching training
222-
- **Distributed**: FSDP2 + Tensor Parallelism
236+
- **Distributed**: FSDP2 + Tensor Parallelism
223237
- ✅ **Mixed Precision**: BF16 by default
224238
- ✅ **WandB**: Automatic logging
225239
- ✅ **Checkpointing**: consolidated, and sharded formats

examples/megatron/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# Megatron Examples
22

3-
Recipes and configuration overrides for megatron training.
3+
Advanced recipes and configuration overrides for training models using the Megatron-Core backend.
4+
5+
## Contents
6+
7+
| Directory | Description |
8+
|-----------|-------------|
9+
| **[recipes](recipes/)** | Complete training recipes for specific models (DiT, Wan) |
10+
| **[override_configs](override_configs/)** | Configuration overrides for customizing Megatron behavior |
11+
12+
## Getting Started
13+
14+
Navigate to a specific recipe in the `recipes/` directory to see model-specific instructions.
Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1-
# Override Configs
1+
# Configuration Overrides
22

3-
Parallelism configuration overrides for different CP/TP/SP sizes.
3+
Collection of YAML configuration files used to override default settings in Megatron training recipes. These are typically used for specifying parallelization strategies (Tensor Parallelism, Context Parallelism, Sequence Parallelism) or data configurations.
4+
5+
## Files
6+
7+
| File | Description |
8+
|------|-------------|
9+
| `wan_pretrain_sample_data.yaml` | Sample data configuration for Wan pre-training. |
10+
11+
## Usage
12+
13+
These configs can be passed to the training script arguments to override defaults.
Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1-
# Recipe
1+
# Model Recipes
22

3-
Training recipes for Wan2.1 pretraining, finetuning, and weight verification.
3+
Collection of end-to-end training recipes for specific model architectures.
4+
5+
## Available Recipes
6+
7+
| Recipe | Description | Status |
8+
|--------|-------------|--------|
9+
| **[DiT](dit/)** | Diffusion Transformer (DiT) training on butterfly dataset | ✅ Stable |
10+
| **[Wan](wan/)** | Wan 2.1 model pre-training and inference | ✅ Stable |
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Wan Recipes
2+
3+
Recipes for training and inferencing Wan models using Megatron-Core.
4+
5+
## Files
6+
7+
- `pretrain_wan.py`: Main pre-training script.
8+
- `inference_wan.py`: Inference script.
9+
- `prepare_energon_dataset_wan.py`: Dataset preparation utility.
10+
11+
## Performance Testing
12+
13+
See **[Performance Test Guide](README_perf_test.md)** for details on running performance benchmarks on different hardware (H100, GB200, etc.).

0 commit comments

Comments
 (0)