Skip to content

Commit 1f0f9be

Browse files
committed
chore: address docs review feedback
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
1 parent 3bee643 commit 1f0f9be

3 files changed

Lines changed: 12 additions & 20 deletions

File tree

.github/workflows/docs-preview.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ on:
55
types: [opened, synchronize, reopened]
66
paths:
77
- "fern/**"
8+
- "docs/assets/recipes/**"
89
- "docs/notebook_source/**"
910
- "docs/colab_notebooks/**"
11+
- "docs/scripts/**"
1012
- "packages/data-designer-config/src/data_designer/config/**"
1113
- "packages/data-designer/src/data_designer/interface/**"
1214
- "packages/data-designer-engine/src/data_designer/engine/column_generators/generators/base.py"

docs/colab_notebooks/7-nemotron-personas.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"If this is your first time using Data Designer, we recommend starting with the [first notebook](https://docs.nvidia.com/nemo/datadesigner/tutorials/the-basics) in this tutorial series.\n",
2727
"\n",
2828
"<div align=\"center\">\n",
29-
" <img src=\"https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesigner/main/docs/devnotes/posts/assets/nemotron-personas/nemotron_persona_via_ndd.png\" alt=\"Nemotron Personas pipeline overview\" width=\"600\" />\n",
29+
" <img src=\"https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesigner/main/fern/assets/nemotron-personas/nemotron_persona_via_ndd.png\" alt=\"Nemotron Personas pipeline overview\" width=\"600\" />\n",
3030
"</div>"
3131
]
3232
},
@@ -95,7 +95,7 @@
9595
"metadata": {},
9696
"outputs": [],
9797
"source": [
98-
"from __future__ import annotations\n",
98+
"from __future__ import annotations # noqa: F404\n",
9999
"\n",
100100
"import json\n",
101101
"from pathlib import Path\n",
@@ -389,7 +389,7 @@
389389
"We are focusing just on the part in the diagram below and seeding persona attributes with PGM + OCEAN details:\n",
390390
"\n",
391391
"<div align=\"center\">\n",
392-
" <img src=\"https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesigner/main/docs/devnotes/posts/assets/nemotron-personas/nemotron_persona_via_ndd_step_2.png\" alt=\"Stage 3: Persona attributes via structured outputs\" width=\"600\" />\n",
392+
" <img src=\"https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesigner/main/fern/assets/nemotron-personas/nemotron_persona_via_ndd_step_2.png\" alt=\"Stage 3: Persona attributes via structured outputs\" width=\"600\" />\n",
393393
"</div>"
394394
]
395395
},
@@ -728,7 +728,7 @@
728728
"Now, let's focus on the second part shown in the diagram below:\n",
729729
"\n",
730730
"<div align=\"center\">\n",
731-
" <img src=\"https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesigner/main/docs/devnotes/posts/assets/nemotron-personas/nemotron_persona_via_ndd_step_3.png\" alt=\"Stage 4: Persona prose synthesis\" width=\"600\" />\n",
731+
" <img src=\"https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesigner/main/fern/assets/nemotron-personas/nemotron_persona_via_ndd_step_3.png\" alt=\"Stage 4: Persona prose synthesis\" width=\"600\" />\n",
732732
"</div>"
733733
]
734734
},

docs/scripts/generate_top_models_figure.py

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@
1010
1111
Renders the ranked input-vs-output token breakdown shown in the README's
1212
"Top models (YTD)" section, styled to match the Data Designer devnote charts
13-
(near-black canvas, NVIDIA-green duotone). The same PNG is written to both
14-
tracked copies so the README and Fern docs site stay in sync:
13+
(near-black canvas, NVIDIA-green duotone). The PNG is written to the Fern image
14+
path rendered by the README and docs site:
1515
16-
docs/images/top-models.png (rendered by the README)
17-
fern/images/top-models.png (Fern's /images/* mirror)
16+
fern/images/top-models.png
1817
1918
The source telemetry export lives at docs/scripts/top-model-usage.csv with
2019
columns: model name, input (context) tokens, output (generated) tokens, plus a
@@ -35,7 +34,6 @@
3534

3635
import argparse
3736
import csv
38-
import shutil
3937
from pathlib import Path
4038

4139
import matplotlib.pyplot as plt
@@ -45,13 +43,8 @@
4543
# Repo root is two levels up from docs/scripts/.
4644
REPO_ROOT = Path(__file__).resolve().parents[2]
4745
DEFAULT_CSV = REPO_ROOT / "docs" / "scripts" / "top-model-usage.csv"
48-
# Tracked copies of the figure; first entry is the canonical render target.
49-
# docs/images/ is what the README renders; fern/images/ is Fern's mirror for
50-
# /images/* references.
51-
TARGETS = (
52-
REPO_ROOT / "docs" / "images" / "top-models.png",
53-
REPO_ROOT / "fern" / "images" / "top-models.png",
54-
)
46+
# Tracked figure path rendered by the README and Fern docs site.
47+
TARGETS = (REPO_ROOT / "fern" / "images" / "top-models.png",)
5548

5649
# ---------------------------------------------------------------- palette ----
5750
BG = "#0E0E0E" # near-black canvas (matches DD devnote charts)
@@ -270,11 +263,8 @@ def main() -> None:
270263
configure_matplotlib()
271264
rows = load_rows(args.csv)
272265

273-
primary, *mirrors = TARGETS
266+
(primary,) = TARGETS
274267
render(rows, primary)
275-
for mirror in mirrors:
276-
mirror.parent.mkdir(parents=True, exist_ok=True)
277-
shutil.copyfile(primary, mirror)
278268

279269
for target in TARGETS:
280270
print(f"wrote {target.relative_to(REPO_ROOT)}")

0 commit comments

Comments
 (0)