From db39b4d11b9ec04b82699bcf358601fa3e4aadbf Mon Sep 17 00:00:00 2001 From: Mike McKiernan Date: Mon, 4 May 2026 15:02:53 -0400 Subject: [PATCH] docs: Refactor model recipe presentation Group the training stages by model in a single toctree for human reader scannability. Signed-off-by: Mike McKiernan --- docs/index.md | 47 +++------------------------------- docs/nemotron/nano3/README.md | 10 ++++++++ docs/nemotron/omni3/README.md | 1 + docs/nemotron/super3/README.md | 14 ++++++++++ 4 files changed, 29 insertions(+), 43 deletions(-) diff --git a/docs/index.md b/docs/index.md index ce9b184aa..e7007dd46 100644 --- a/docs/index.md +++ b/docs/index.md @@ -164,52 +164,13 @@ use-case-examples/sql-lora-finetuning-and-deployment/README.md :caption: Training Recipes :hidden: -nemotron/nano3/README.md -nemotron/omni3/README.md -nemotron/super3/README.md -nemotron/embed/README.md +Nemotron 3 Nano +Nemotron 3 Omni +Nemotron 3 Super +Llama Nemotron Embed nemotron/artifacts.md ``` -```{toctree} -:caption: Nano3 Stages -:hidden: - -nemotron/nano3/pretrain.md -nemotron/nano3/sft.md -nemotron/nano3/rl.md -nemotron/nano3/evaluate.md -nemotron/nano3/import.md -``` - -```{toctree} -:caption: Omni3 Stages -:hidden: - -nemotron/omni3/README.md -nemotron/omni3/sft.md -nemotron/omni3/rl.md -nemotron/omni3/rl/data-prep.md -nemotron/omni3/architecture.md -nemotron/omni3/inference.md -``` - -```{toctree} -:caption: Super3 Stages -:hidden: - -nemotron/super3/README.md -nemotron/super3/pretrain.md -nemotron/super3/sft.md -nemotron/super3/rl/index.md -nemotron/super3/rl/rlvr.md -nemotron/super3/rl/swe.md -nemotron/super3/rl/rlhf.md -nemotron/super3/rl/data-prep.md -nemotron/super3/evaluate.md -nemotron/super3/quantization.md -``` - ```{toctree} :caption: Nemotron Kit :hidden: diff --git a/docs/nemotron/nano3/README.md b/docs/nemotron/nano3/README.md index f8c03cc09..47e2e00b0 100644 --- a/docs/nemotron/nano3/README.md +++ b/docs/nemotron/nano3/README.md @@ -275,3 +275,13 @@ wandb login - [NVIDIA AI Stack](../nvidia-stack.md) - [CLI Framework](../cli.md) - [Data Preparation Module](../data-prep.md) + +```{toctree} +:hidden: + +pretrain.md +sft.md +rl.md +evaluate.md +import.md +``` diff --git a/docs/nemotron/omni3/README.md b/docs/nemotron/omni3/README.md index 5acecf5ce..c86a784ab 100644 --- a/docs/nemotron/omni3/README.md +++ b/docs/nemotron/omni3/README.md @@ -266,6 +266,7 @@ Usage: nemotron omni3 [OPTIONS] COMMAND [ARGS]... sft.md rl.md +rl/data-prep.md architecture.md inference.md ``` diff --git a/docs/nemotron/super3/README.md b/docs/nemotron/super3/README.md index 04e4c2841..bc1d8d2f0 100644 --- a/docs/nemotron/super3/README.md +++ b/docs/nemotron/super3/README.md @@ -258,3 +258,17 @@ wandb login - [NVIDIA AI Stack](../nvidia-stack.md) - [Execution through NeMo-Run](../../nemo_runspec/nemo-run.md) - [Data Preparation Module](../data-prep.md) + +```{toctree} +:hidden: + +pretrain.md +sft.md +rl/index.md +rl/rlvr.md +rl/swe.md +rl/rlhf.md +rl/data-prep.md +evaluate.md +quantization.md +```