The Basics

View as Markdown

🎨 Data Designer Tutorial: The Basics

📚 What you'll learn

This notebook demonstrates the basics of Data Designer by generating a simple product review dataset.

📦 Import Data Designer

  • data_designer.config provides access to the configuration API.

  • DataDesigner is the main interface for data generation.

Python
1import data_designer.config as dd
2from data_designer.interface import DataDesigner
3

⚙️ Initialize the Data Designer interface

  • DataDesigner is the main object responsible for managing the data generation process.

  • When initialized without arguments, the default model providers are used.

Python
1data_designer = DataDesigner()
2

🎛️ Define model configurations

  • Each ModelConfig defines a model that can be used during the generation process.

  • The "model alias" is used to reference the model in the Data Designer config (as we will see below).

  • The "model provider" is the external service that hosts the model (see the model config docs for more details).

  • By default, we use build.nvidia.com as the model provider.

Python
1# This name is set in the model provider configuration.
2MODEL_PROVIDER = "nvidia"
3
4# The model ID is from build.nvidia.com.
5MODEL_ID = "nvidia/nemotron-3-nano-30b-a3b"
6
7# We choose this alias to be descriptive for our use case.
8MODEL_ALIAS = "nemotron-nano-v3"
9
10model_configs = [
11 dd.ModelConfig(
12 alias=MODEL_ALIAS,
13 model=MODEL_ID,
14 provider=MODEL_PROVIDER,
15 inference_parameters=dd.ChatCompletionInferenceParams(
16 temperature=1.0,
17 top_p=1.0,
18 max_tokens=2048,
19 extra_body={"chat_template_kwargs": {"enable_thinking": False}},
20 ),
21 )
22]
23

🏗️ Initialize the Data Designer Config Builder

  • The Data Designer config defines the dataset schema and generation process.

  • The config builder provides an intuitive interface for building this configuration.

  • The list of model configs is provided to the builder at initialization.

Python
1config_builder = dd.DataDesignerConfigBuilder(model_configs=model_configs)
2

🎲 Getting started with sampler columns

  • Sampler columns offer non-LLM based generation of synthetic data.

  • They are particularly useful for steering the diversity of the generated data, as we demonstrate below.


You can view available samplers using the config builder's info property:

Python
1config_builder.info.display("samplers")
2
Output
─────────────────────────────────────────── NeMo Data Designer Samplers ───────────────────────────────────────────

┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
┃ Type                Parameter                 Data Type                          Required  Constraints      ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
│ bernoulli          │ p                        │ number                            │    ✓     │ >= 0.0, <= 1.0   │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ bernoulli_mixture  │ p                        │ number                            │    ✓     │ >= 0.0, <= 1.0   │
│                    │ dist_name                │ string                            │    ✓     │                  │
│                    │ dist_params              │ dict                              │    ✓     │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ binomial           │ n                        │ integer                           │    ✓     │                  │
│                    │ p                        │ number                            │    ✓     │ >= 0.0, <= 1.0   │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ category           │ values                   │ string[] | integer[] | number[]   │    ✓     │ len > 1          │
│                    │ weights                  │ number[] | null                   │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ datetime           │ start                    │ string                            │    ✓     │                  │
│                    │ end                      │ string                            │    ✓     │                  │
│                    │ unit                     │ string                            │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ gaussian           │ mean                     │ number                            │    ✓     │                  │
│                    │ stddev                   │ number                            │    ✓     │                  │
│                    │ decimal_places           │ integer | null                    │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ person             │ locale                   │ string                            │          │                  │
│                    │ sex                      │ string | null                     │          │                  │
│                    │ city                     │ string | string[] | null          │          │                  │
│                    │ age_range                │ integer[]                         │          │ len > 2, len < 2 │
│                    │ select_field_values      │ object | null                     │          │                  │
│                    │ with_synthetic_personas  │ boolean                           │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ person_from_faker  │ locale                   │ string                            │          │                  │
│                    │ sex                      │ string | null                     │          │                  │
│                    │ city                     │ string | string[] | null          │          │                  │
│                    │ age_range                │ integer[]                         │          │ len > 2, len < 2 │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ poisson            │ mean                     │ number                            │    ✓     │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ scipy              │ dist_name                │ string                            │    ✓     │                  │
│                    │ dist_params              │ dict                              │    ✓     │                  │
│                    │ decimal_places           │ integer | null                    │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ subcategory        │ category                 │ string                            │    ✓     │                  │
│                    │ values                   │ dict                              │    ✓     │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ timedelta          │ dt_min                   │ integer                           │    ✓     │ >= 0             │
│                    │ dt_max                   │ integer                           │    ✓     │ > 0              │
│                    │ reference_column_name    │ string                            │    ✓     │                  │
│                    │ unit                     │ string                            │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ uniform            │ low                      │ number                            │    ✓     │                  │
│                    │ high                     │ number                            │    ✓     │                  │
│                    │ decimal_places           │ integer | null                    │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
├────────────────────┼──────────────────────────┼───────────────────────────────────┼──────────┼──────────────────┤
│ uuid               │ prefix                   │ string | null                     │          │                  │
│                    │ short_form               │ boolean                           │          │                  │
│                    │ uppercase                │ boolean                           │          │                  │
│                    │ sampler_type             │ string                            │          │                  │
└────────────────────┴──────────────────────────┴───────────────────────────────────┴──────────┴──────────────────┘

Let's start designing our product review dataset by adding product category and subcategory columns.

Python
1config_builder.add_column(
2 dd.SamplerColumnConfig(
3 name="product_category",
4 sampler_type=dd.SamplerType.CATEGORY,
5 params=dd.CategorySamplerParams(
6 values=[
7 "Electronics",
8 "Clothing",
9 "Home & Kitchen",
10 "Books",
11 "Home Office",
12 ],
13 ),
14 )
15)
16
17config_builder.add_column(
18 dd.SamplerColumnConfig(
19 name="product_subcategory",
20 sampler_type=dd.SamplerType.SUBCATEGORY,
21 params=dd.SubcategorySamplerParams(
22 category="product_category",
23 values={
24 "Electronics": [
25 "Smartphones",
26 "Laptops",
27 "Headphones",
28 "Cameras",
29 "Accessories",
30 ],
31 "Clothing": [
32 "Men's Clothing",
33 "Women's Clothing",
34 "Winter Coats",
35 "Activewear",
36 "Accessories",
37 ],
38 "Home & Kitchen": [
39 "Appliances",
40 "Cookware",
41 "Furniture",
42 "Decor",
43 "Organization",
44 ],
45 "Books": [
46 "Fiction",
47 "Non-Fiction",
48 "Self-Help",
49 "Textbooks",
50 "Classics",
51 ],
52 "Home Office": [
53 "Desks",
54 "Chairs",
55 "Storage",
56 "Office Supplies",
57 "Lighting",
58 ],
59 },
60 ),
61 )
62)
63
64config_builder.add_column(
65 dd.SamplerColumnConfig(
66 name="target_age_range",
67 sampler_type=dd.SamplerType.CATEGORY,
68 params=dd.CategorySamplerParams(values=["18-25", "25-35", "35-50", "50-65", "65+"]),
69 )
70)
71
72# Optionally validate that the columns are configured correctly.
73data_designer.validate(config_builder)
74
Output
[17:18:49] [INFO] ✅ Validation passed

Next, let's add samplers to generate data related to the customer and their review.

Python
1config_builder.add_column(
2 dd.SamplerColumnConfig(
3 name="customer",
4 sampler_type=dd.SamplerType.PERSON_FROM_FAKER,
5 params=dd.PersonFromFakerSamplerParams(age_range=[18, 70], locale="en_US"),
6 )
7)
8
9config_builder.add_column(
10 dd.SamplerColumnConfig(
11 name="number_of_stars",
12 sampler_type=dd.SamplerType.UNIFORM,
13 params=dd.UniformSamplerParams(low=1, high=5),
14 convert_to="int", # Convert the sampled float to an integer.
15 )
16)
17
18config_builder.add_column(
19 dd.SamplerColumnConfig(
20 name="review_style",
21 sampler_type=dd.SamplerType.CATEGORY,
22 params=dd.CategorySamplerParams(
23 values=["rambling", "brief", "detailed", "structured with bullet points"],
24 weights=[1, 2, 2, 1],
25 ),
26 )
27)
28
29data_designer.validate(config_builder)
30
Output
[17:18:49] [INFO] ✅ Validation passed

🦜 LLM-generated columns

  • The real power of Data Designer comes from leveraging LLMs to generate text, code, and structured data.

  • When prompting the LLM, we can use Jinja templating to reference other columns in the dataset.

  • As we see below, nested json fields can be accessed using dot notation.

Python
1config_builder.add_column(
2 dd.LLMTextColumnConfig(
3 name="product_name",
4 prompt=(
5 "You are a helpful assistant that generates product names. DO NOT add quotes around the product name.\n\n"
6 "Come up with a creative product name for a product in the '{{ product_category }}' category, focusing "
7 "on products related to '{{ product_subcategory }}'. The target age range of the ideal customer is "
8 "{{ target_age_range }} years old. Respond with only the product name, no other text."
9 ),
10 model_alias=MODEL_ALIAS,
11 )
12)
13
14config_builder.add_column(
15 dd.LLMTextColumnConfig(
16 name="customer_review",
17 prompt=(
18 "You are a customer named {{ customer.first_name }} from {{ customer.city }}, {{ customer.state }}. "
19 "You are {{ customer.age }} years old and recently purchased a product called {{ product_name }}. "
20 "Write a review of this product, which you gave a rating of {{ number_of_stars }} stars. "
21 "The style of the review should be '{{ review_style }}'. "
22 "Respond with only the review, no other text."
23 ),
24 model_alias=MODEL_ALIAS,
25 )
26)
27
28data_designer.validate(config_builder)
29
Output
[17:18:49] [INFO] ✅ Validation passed

🔁 Iteration is key – preview the dataset!

  1. Use the preview method to generate a sample of records quickly.

  2. Inspect the results for quality and format issues.

  3. Adjust column configurations, prompts, or parameters as needed.

  4. Re-run the preview until satisfied.

Python
1preview = data_designer.preview(config_builder, num_records=2)
2
Output
[17:18:49] [INFO] 🖼️ Preview generation in progress
[17:18:49] [INFO]   |-- 🔒 Jinja rendering engine: secure
[17:18:49] [INFO] ✅ Validation passed
[17:18:49] [INFO] ⛓️ Sorting column configs into a Directed Acyclic Graph
[17:18:49] [INFO] Skipping model health checks because DATA_DESIGNER_SKIP_MODEL_HEALTH_CHECKS=1
[17:18:49] [INFO] ⚡ Using async task-queue preview
[17:18:49] [INFO] 📝 llm-text model config for column 'product_name'
[17:18:49] [INFO]   |-- model: 'nvidia/nemotron-3-nano-30b-a3b'
[17:18:49] [INFO]   |-- model alias: 'nemotron-nano-v3'
[17:18:49] [INFO]   |-- model provider: 'nvidia'
[17:18:49] [INFO]   |-- inference parameters:
[17:18:49] [INFO]   |  |-- generation_type=chat-completion
[17:18:49] [INFO]   |  |-- max_parallel_requests=4
[17:18:49] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[17:18:49] [INFO]   |  |-- temperature=1.00
[17:18:49] [INFO]   |  |-- top_p=1.00
[17:18:49] [INFO]   |  |-- max_tokens=2048
[17:18:49] [INFO] 📝 llm-text model config for column 'customer_review'
[17:18:49] [INFO]   |-- model: 'nvidia/nemotron-3-nano-30b-a3b'
[17:18:49] [INFO]   |-- model alias: 'nemotron-nano-v3'
[17:18:49] [INFO]   |-- model provider: 'nvidia'
[17:18:49] [INFO]   |-- inference parameters:
[17:18:49] [INFO]   |  |-- generation_type=chat-completion
[17:18:49] [INFO]   |  |-- max_parallel_requests=4
[17:18:49] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[17:18:49] [INFO]   |  |-- temperature=1.00
[17:18:49] [INFO]   |  |-- top_p=1.00
[17:18:49] [INFO]   |  |-- max_tokens=2048
[17:18:49] [INFO] ⚡️ Async generation: 2 column(s) (column 'product_name', column 'customer_review'), 4 tasks across 1 row group(s)
[17:18:49] [INFO] 🚀 (1/1) Dispatching with 2 records
[17:18:49] [INFO] 🎲 (1/1) Preparing samplers to generate 2 records across 6 columns
[17:19:02] [INFO] 📊 Progress [13.4s]:
[17:19:02] [INFO]   |-- 🐔 column 'product_name': 2/2 (100%) 0.1 rec/s
[17:19:02] [INFO]   |-- 🚗 column 'customer_review': 1/2 (50%) 0.1 rec/s
[17:19:02] [INFO] 📊 Progress [13.8s]:
[17:19:02] [INFO]   |-- 🐔 column 'product_name': 2/2 (100%) 0.1 rec/s
[17:19:02] [INFO]   |-- 🚀 column 'customer_review': 2/2 (100%) 0.1 rec/s
[17:19:03] [INFO] ✅ Async generation complete [13.8s]: 4 ok, 0 failed across 2 column(s)
[17:19:03] [INFO] 📊 Model usage summary:
[17:19:03] [INFO]   |-- model: nvidia/nemotron-3-nano-30b-a3b
[17:19:03] [INFO]   |-- tokens: input=359, output=1109, total=1468, tps=105
[17:19:03] [INFO]   |-- requests: success=4, failed=0, total=4, rpm=17
[17:19:03] [INFO] 📐 Measuring dataset column statistics:
[17:19:03] [INFO]   |-- 🎲 column: 'product_category'
[17:19:03] [INFO]   |-- 🎲 column: 'product_subcategory'
[17:19:03] [INFO]   |-- 🎲 column: 'target_age_range'
[17:19:03] [INFO]   |-- 🎲 column: 'customer'
[17:19:03] [INFO]   |-- 🎲 column: 'number_of_stars'
[17:19:03] [INFO]   |-- 🎲 column: 'review_style'
[17:19:03] [INFO]   |-- 📝 column: 'product_name'
[17:19:03] [INFO]   |-- 📝 column: 'customer_review'
[17:19:03] [INFO] ☀️ Preview complete!
Python
1# Run this cell multiple times to cycle through the 2 preview records.
2preview.display_sample_record()
3
Output
[index: 0]
                                                                                                              
                                              Generated Columns                                               
┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Name                 Value                                                                                ┃
┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ product_category    │ Books                                                                                │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ product_subcategory │ Non-Fiction                                                                          │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ target_age_range    │ 35-50                                                                                │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ customer            │ {                                                                                    │
│                     │     'uuid': '3b224ef2-d1f0-486a-842e-b48a6eebeb8b',                                  │
│                     │     'locale': 'en_US',                                                               │
│                     │     'first_name': 'Ashley',                                                          │
│                     │     'last_name': 'Avery',                                                            │
│                     │     'middle_name': None,                                                             │
│                     │     'sex': 'Female',                                                                 │
│                     │     'street_number': '47655',                                                        │
│                     │     'street_name': 'Kaitlin Shores',                                                 │
│                     │     'city': 'New Jamesborough',                                                      │
│                     │     'state': 'Maine',                                                                │
│                     │     'postcode': '22895',                                                             │
│                     │     'age': 51,                                                                       │
│                     │     'birth_date': '1975-02-03',                                                      │
│                     │     'country': 'Netherlands Antilles',                                               │
│                     │     'marital_status': 'divorced',                                                    │
│                     │     'education_level': 'graduate',                                                   │
│                     │     'unit': '',                                                                      │
│                     │     'occupation': 'Armed forces training and education officer',                     │
│                     │     'phone_number': '945.649.2510',                                                  │
│                     │     'bachelors_field': 'education'                                                   │
│                     │ }                                                                                    │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ number_of_stars     │ 4                                                                                    │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ review_style        │ detailed                                                                             │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ product_name        │ Mindful Mastery Lifecycle                                                            │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ customer_review     │ **Product:** Mindful Mastery Lifecycle                                               │
│                     │ **Rating:** ★★★★☆ (4 stars)                                                          │
│                     │                                                                                      │
│                     │ I am a 51‑year‑old resident of New Jamesborough, Maine, and after carefully          │
│                     │ evaluating the Mindful Mastery Lifecycle, I decided to purchase it last month.       │
│                     │ Overall, the experience has been positive, though there are a few nuances worth      │
│                     │ noting.                                                                              │
│                     │                                                                                      │
│                     │ **First Impressions & Design**                                                       │
│                     │ The packaging is clean and professional, featuring a sleek blue‑gray box with        │
│                     │ embossed lettering that conveys a sense of calm authority. Inside, the layout is     │
│                     │ intuitive: the workbook, a set of guided meditation cards, and a QR‑code tutorial    │
│                     │ booklet are neatly organized. The paper quality is solid—thick, matte-finished pages │
│                     │ that resist creasing during repeated use.                                            │
│                     │                                                                                      │
│                     │ **Content & Usability**                                                              │
│                     │ The program’s structure follows a logical 12‑week progression, each week building on │
│                     │ the previous one with a blend of short video lessons (5–10 minutes), reflective      │
│                     │ journaling prompts, and practical exercises. I appreciate how the curriculum         │
│                     │ integrates mindfulness principles with performance enhancement techniques—something  │
│                     │ that stood out to me given my background in project management and community         │
│                     │ volunteering.                                                                        │
│                     │                                                                                      │
│                     │ - **Weekly Themes:** From “Foundations of Presence” to “Sustaining Flow,” the themes │
│                     │ are thoughtfully sequenced and provide clear, incremental goals.                     │
│                     │ - **Exercises:** The guided visualizations are well‑written, and the accompanying    │
│                     │ audio tracks (downloadable via the QR code) are soothing without being overly        │
│                     │ ambient.                                                                             │
│                     │ - **Tracking Tools:** The included progress tracker is simple yet effective; marking │
│                     │ achieved milestones with stickers reinforced a sense of accomplishment.              │
│                     │                                                                                      │
│                     │ **What I Liked Most**                                                                │
│                     │ - **Tailored for Adult Learners:** The language is clear, avoiding jargon that would │
│                     │ alienate a more mature audience.                                                     │
│                     │ - **Community Support:** Access to an online forum where participants share          │
│                     │ reflections was valuable; hearing how others in similar life stages navigated        │
│                     │ challenges added depth to my own practice.                                           │
│                     │ - **Time Flexibility:** Each module can be completed within a week, fitting nicely   │
│                     │ into my busy schedule of family commitments and part‑time work at the local library. │
│                     │                                                                                      │
│                     │ **Areas for Improvement**                                                            │
│                     │ 1. **Depth of Advanced Modules:** While the initial weeks are rich, the final two    │
│                     │ modules feel compressed, offering limited space for deeper exploration—particularly  │
│                     │ in integrating mindfulness into long‑term habit formation.                           │
│                     │ 2. **Pricing:** The program’s price point sits at the higher end of the market for a │
│                     │ self‑guided course. A modest discount for early adopters would have made it feel     │
│                     │ more accessible.                                                                     │
│                     │ 3. **Technical Support:** Occasionally, the video streaming platform lagged on older │
│                     │ devices, requiring a restart to resume playback.                                     │
│                     │                                                                                      │
│                     │ **Final Thoughts**                                                                   │
│                     │ Overall, Mindful Mastery Lifecycle delivers a solid, well‑structured experience      │
│                     │ tailored to adult learners seeking both mindfulness practice and performance         │
│                     │ enhancement. The strengths—clear progression, varied resources, and an engaging      │
│                     │ community—outweigh the minor drawbacks. For anyone in mid‑life looking to cultivate  │
│                     │ presence while advancing personal or professional goals, this program is a           │
│                     │ worthwhile investment, especially when approached with realistic expectations about  │
│                     │ pacing and cost.                                                                     │
│                     │                                                                                      │
│                     │ **Bottom Line:** A thoughtful, well‑designed course that merits its four‑star        │
│                     │ rating; with a few refinements, it could easily become a five‑star staple in the     │
│                     │ mindfulness‑training market.                                                         │
└─────────────────────┴──────────────────────────────────────────────────────────────────────────────────────┘
                                                                                                              
Python
1# The preview dataset is available as a pandas DataFrame.
2preview.dataset
3
Output
product_category product_subcategory target_age_range customer number_of_stars review_style product_name customer_review
0 Books Non-Fiction 35-50 {'uuid': '3b224ef2-d1f0-486a-842e-b48a6eebeb8b... 4 detailed Mindful Mastery Lifecycle **Product:** Mindful Mastery Lifecycle \n**Ra...
1 Clothing Women's Clothing 18-25 {'uuid': '1c0cebfc-5b28-45f1-8bfe-f9874955ae33... 4 detailed VibeCraft Lounge Set I’m Erin from Lisaborough, Missouri, and I’m 4...

📊 Analyze the generated data

  • Data Designer automatically generates a basic statistical analysis of the generated data.

  • This analysis is available via the analysis property of generation result objects.

Python
1# Print the analysis as a table.
2preview.analysis.to_report()
3
Output
──────────────────────────────────────── 🎨 Data Designer Dataset Profile ─────────────────────────────────────────

                                                                                                                   
                                                 Dataset Overview                                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ number of records                number of columns                percent complete records                    ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 2                               │ 8                               │ 100.0%                                      │
└─────────────────────────────────┴─────────────────────────────────┴─────────────────────────────────────────────┘
                                                                                                                   
                                                                                                                   
                                                🎲 Sampler Columns                                                 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ column name                           data type             number unique values                sampler type ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ product_category               │          string │                      2 (100.0%) │                   category │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ product_subcategory            │          string │                      2 (100.0%) │                subcategory │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ target_age_range               │          string │                      2 (100.0%) │                   category │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ customer                       │            dict │                      2 (100.0%) │          person_from_faker │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ number_of_stars                │             int │                       1 (50.0%) │                    uniform │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ review_style                   │          string │                       1 (50.0%) │                   category │
└────────────────────────────────┴─────────────────┴─────────────────────────────────┴────────────────────────────┘
                                                                                                                   
                                                                                                                   
                                                📝 LLM-Text Columns                                                
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                                                                       prompt tokens       completion tokens ┃
┃ column name                data type        number unique values         per record              per record ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━┩
│ product_name          │        string │                 2 (100.0%) │      74.5 +/- 0.5 │            4.5 +/- 0.7 │
├───────────────────────┼───────────────┼────────────────────────────┼───────────────────┼────────────────────────┤
│ customer_review       │        string │                 2 (100.0%) │      69.5 +/- 0.5 │        519.5 +/- 224.2 │
└───────────────────────┴───────────────┴────────────────────────────┴───────────────────┴────────────────────────┘
                                                                                                                   
                                                                                                                   
╭────────────────────────────────────────────────── Table Notes ──────────────────────────────────────────────────╮
                                                                                                                 
  1. All token statistics are based on a sample of max(1000, len(dataset)) records.                              
  2. Tokens are calculated using tiktoken's cl100k_base tokenizer.                                               
                                                                                                                 
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
                                                                                                                   
───────────────────────────────────────────────────────────────────────────────────────────────────────────────────

🆙 Scale up!

  • Happy with your preview data?

  • Use the create method to submit larger Data Designer generation jobs.

Python
1results = data_designer.create(config_builder, num_records=10, dataset_name="tutorial-1")
2
Output
[17:19:03] [INFO] OpenTelemetry metrics available at http://127.0.0.1:9464/metrics
[17:19:03] [INFO] 🎨 Creating Data Designer dataset
[17:19:03] [INFO]   |-- 🔒 Jinja rendering engine: secure
[17:19:03] [INFO] ✅ Validation passed
[17:19:03] [INFO] ⛓️ Sorting column configs into a Directed Acyclic Graph
[17:19:03] [INFO] Skipping model health checks because DATA_DESIGNER_SKIP_MODEL_HEALTH_CHECKS=1
[17:19:03] [INFO] ⚡ Using async task-queue builder
[17:19:03] [INFO] 📝 llm-text model config for column 'product_name'
[17:19:03] [INFO]   |-- model: 'nvidia/nemotron-3-nano-30b-a3b'
[17:19:03] [INFO]   |-- model alias: 'nemotron-nano-v3'
[17:19:03] [INFO]   |-- model provider: 'nvidia'
[17:19:03] [INFO]   |-- inference parameters:
[17:19:03] [INFO]   |  |-- generation_type=chat-completion
[17:19:03] [INFO]   |  |-- max_parallel_requests=4
[17:19:03] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[17:19:03] [INFO]   |  |-- temperature=1.00
[17:19:03] [INFO]   |  |-- top_p=1.00
[17:19:03] [INFO]   |  |-- max_tokens=2048
[17:19:03] [INFO] 📝 llm-text model config for column 'customer_review'
[17:19:03] [INFO]   |-- model: 'nvidia/nemotron-3-nano-30b-a3b'
[17:19:03] [INFO]   |-- model alias: 'nemotron-nano-v3'
[17:19:03] [INFO]   |-- model provider: 'nvidia'
[17:19:03] [INFO]   |-- inference parameters:
[17:19:03] [INFO]   |  |-- generation_type=chat-completion
[17:19:03] [INFO]   |  |-- max_parallel_requests=4
[17:19:03] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[17:19:03] [INFO]   |  |-- temperature=1.00
[17:19:03] [INFO]   |  |-- top_p=1.00
[17:19:03] [INFO]   |  |-- max_tokens=2048
[17:19:03] [INFO] ⚡️ Async generation: 2 column(s) (column 'product_name', column 'customer_review'), 20 tasks across 1 row group(s)
[17:19:03] [INFO] 🚀 (1/1) Dispatching with 10 records
[17:19:03] [INFO] 🎲 (1/1) Preparing samplers to generate 10 records across 6 columns
[17:19:10] [INFO] 📊 Progress [6.5s]:
[17:19:10] [INFO]   |-- 🌑 column 'product_name': 2/10 (20%) 0.3 rec/s
[17:19:10] [INFO]   |-- 🌑 column 'customer_review': 1/10 (10%) 0.2 rec/s
[17:19:18] [INFO] 📊 Progress [15.1s]:
[17:19:18] [INFO]   |-- 🌖 column 'product_name': 9/10 (90%) 0.6 rec/s
[17:19:18] [INFO]   |-- 🌘 column 'customer_review': 4/10 (40%) 0.3 rec/s
[17:19:29] [INFO] 📊 Progress [25.6s]:
[17:19:29] [INFO]   |-- 🌕 column 'product_name': 10/10 (100%) 0.4 rec/s
[17:19:29] [INFO]   |-- 🌖 column 'customer_review': 9/10 (90%) 0.4 rec/s
[17:19:33] [INFO] 📊 Progress [29.2s]:
[17:19:33] [INFO]   |-- 🌕 column 'product_name': 10/10 (100%) 0.3 rec/s
[17:19:33] [INFO]   |-- 🌕 column 'customer_review': 10/10 (100%) 0.3 rec/s
[17:19:33] [INFO] ✅ Async generation complete [29.2s]: 20 ok, 0 failed across 2 column(s)
[17:19:33] [INFO] 📊 Model usage summary:
[17:19:33] [INFO]   |-- model: nvidia/nemotron-3-nano-30b-a3b
[17:19:33] [INFO]   |-- tokens: input=1813, output=3952, total=5765, tps=194
[17:19:33] [INFO]   |-- requests: success=20, failed=0, total=20, rpm=40
[17:19:33] [INFO] 📐 Measuring dataset column statistics:
[17:19:33] [INFO]   |-- 🎲 column: 'product_category'
[17:19:33] [INFO]   |-- 🎲 column: 'product_subcategory'
[17:19:33] [INFO]   |-- 🎲 column: 'target_age_range'
[17:19:33] [INFO]   |-- 🎲 column: 'customer'
[17:19:33] [INFO]   |-- 🎲 column: 'number_of_stars'
[17:19:33] [INFO]   |-- 🎲 column: 'review_style'
[17:19:33] [INFO]   |-- 📝 column: 'product_name'
[17:19:33] [INFO]   |-- 📝 column: 'customer_review'
Python
1# Load the generated dataset as a pandas DataFrame.
2dataset = results.load_dataset()
3
4dataset.head()
5
Output
product_category product_subcategory target_age_range customer number_of_stars review_style product_name customer_review
0 Clothing Winter Coats 18-25 {'uuid': '8756324b-b0e3-4f8a-861c-38450b1d10ba... 2 rambling Arctic Pulse Jacket I bought the Arctic Pulse Jacket from JacketGr...
1 Clothing Winter Coats 25-35 {'uuid': '82e1b2ca-5032-4646-ad0c-7003fbe6f330... 3 structured with bullet points StormChaser Insulated Overcoat **StormChaser Insulated Overcoat – 3 Stars** ...
2 Home Office Chairs 25-35 {'uuid': '4a195f1d-3480-4c4f-8ed0-3d1723a13100... 4 brief Zenith Swivel Chair I'm 52 and bought the Zenith Swivel Chair from...
3 Books Fiction 35-50 {'uuid': '081100a4-5df8-42c0-b90a-4d88050dbcd2... 3 brief Midlife Myths: Unfolding Contemporary Fiction ... 3 stars—I enjoyed the clever stories but felt ...
4 Electronics Laptops 50-65 {'uuid': 'f343e886-4e86-4bd9-b9a7-8bc40afdc31c... 4 detailed GoldenLite Ultrabook I’m Brandi from South Pamelamouth, South Dakot...
Python
1# Load the analysis results into memory.
2analysis = results.load_analysis()
3
4analysis.to_report()
5
Output
──────────────────────────────────────── 🎨 Data Designer Dataset Profile ─────────────────────────────────────────

                                                                                                                   
                                                 Dataset Overview                                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ number of records                number of columns                percent complete records                    ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 10                              │ 8                               │ 100.0%                                      │
└─────────────────────────────────┴─────────────────────────────────┴─────────────────────────────────────────────┘
                                                                                                                   
                                                                                                                   
                                                🎲 Sampler Columns                                                 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ column name                           data type             number unique values                sampler type ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ product_category               │          string │                       5 (50.0%) │                   category │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ product_subcategory            │          string │                       8 (80.0%) │                subcategory │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ target_age_range               │          string │                       5 (50.0%) │                   category │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ customer                       │            dict │                     10 (100.0%) │          person_from_faker │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ number_of_stars                │             int │                       4 (40.0%) │                    uniform │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ review_style                   │          string │                       4 (40.0%) │                   category │
└────────────────────────────────┴─────────────────┴─────────────────────────────────┴────────────────────────────┘
                                                                                                                   
                                                                                                                   
                                                📝 LLM-Text Columns                                                
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                                                                       prompt tokens       completion tokens ┃
┃ column name                data type        number unique values         per record              per record ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━┩
│ product_name          │        string │                10 (100.0%) │      74.0 +/- 0.7 │            5.0 +/- 6.6 │
├───────────────────────┼───────────────┼────────────────────────────┼───────────────────┼────────────────────────┤
│ customer_review       │        string │                10 (100.0%) │      69.5 +/- 7.3 │        244.5 +/- 355.0 │
└───────────────────────┴───────────────┴────────────────────────────┴───────────────────┴────────────────────────┘
                                                                                                                   
                                                                                                                   
╭────────────────────────────────────────────────── Table Notes ──────────────────────────────────────────────────╮
                                                                                                                 
  1. All token statistics are based on a sample of max(1000, len(dataset)) records.                              
  2. Tokens are calculated using tiktoken's cl100k_base tokenizer.                                               
                                                                                                                 
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
                                                                                                                   
───────────────────────────────────────────────────────────────────────────────────────────────────────────────────

⏭️ Next Steps

Now that you've seen the basics of Data Designer, check out the following notebooks to learn more about: