Skip to navigation

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.5-lightning-30b-a3b"
6
7# We choose this alias to be descriptive for our use case.
8MODEL_ALIAS = "nemotron-lightning"
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=0.95,
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
[16:02:00] [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
[16:02:00] [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
[16:02:00] [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
[16:02:00] [INFO] 📸 Preview generation in progress
[16:02:00] [INFO]   |-- 🔒 Jinja rendering engine: secure
[16:02:00] [INFO] ✅ Validation passed
[16:02:00] [INFO] ⛓️ Sorting column configs into a Directed Acyclic Graph
[16:02:00] [INFO] Skipping model health checks because DATA_DESIGNER_SKIP_MODEL_HEALTH_CHECKS=1
[16:02:00] [INFO] ⚡ Using async task-queue preview
[16:02:00] [INFO] 📝 llm-text model config for column 'product_name'
[16:02:00] [INFO]   |-- model: 'nvidia/nemotron-3.5-lightning-30b-a3b'
[16:02:00] [INFO]   |-- model alias: 'nemotron-lightning'
[16:02:00] [INFO]   |-- model provider: 'nvidia'
[16:02:00] [INFO]   |-- inference parameters:
[16:02:00] [INFO]   |  |-- generation_type=chat-completion
[16:02:00] [INFO]   |  |-- max_parallel_requests=4
[16:02:00] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[16:02:00] [INFO]   |  |-- temperature=1.00
[16:02:00] [INFO]   |  |-- top_p=0.95
[16:02:00] [INFO]   |  |-- max_tokens=2048
[16:02:00] [INFO] 📝 llm-text model config for column 'customer_review'
[16:02:00] [INFO]   |-- model: 'nvidia/nemotron-3.5-lightning-30b-a3b'
[16:02:00] [INFO]   |-- model alias: 'nemotron-lightning'
[16:02:00] [INFO]   |-- model provider: 'nvidia'
[16:02:00] [INFO]   |-- inference parameters:
[16:02:00] [INFO]   |  |-- generation_type=chat-completion
[16:02:00] [INFO]   |  |-- max_parallel_requests=4
[16:02:00] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[16:02:00] [INFO]   |  |-- temperature=1.00
[16:02:00] [INFO]   |  |-- top_p=0.95
[16:02:00] [INFO]   |  |-- max_tokens=2048
[16:02:00] [INFO] ⚡️ Async generation: 2 column(s) (column 'product_name', column 'customer_review'), 4 tasks across 1 row group(s)
[16:02:00] [INFO] 🚀 (1/1) Dispatching with 2 records
[16:02:00] [INFO] 🎲 (1/1) Preparing samplers to generate 2 records across 6 columns
[16:02:08] [INFO] 📊 Progress [8.1s]:
[16:02:08] [INFO]   |-- 🤩 column 'product_name': 2/2 (100%) 0.2 rec/s
[16:02:08] [INFO]   |-- 🌗 column 'customer_review': 1/2 (50%) 0.1 rec/s
[16:02:10] [INFO] 📊 Progress [9.9s]:
[16:02:10] [INFO]   |-- 🤩 column 'product_name': 2/2 (100%) 0.2 rec/s
[16:02:10] [INFO]   |-- 🌕 column 'customer_review': 2/2 (100%) 0.2 rec/s
[16:02:10] [INFO] ✅ Async generation complete [9.9s]: 4 ok, 0 failed across 2 column(s)
[16:02:10] [INFO] 📊 Model usage summary:
[16:02:10] [INFO]   |-- model: nvidia/nemotron-3.5-lightning-30b-a3b
[16:02:10] [INFO]   |-- tokens: input=354, output=150, reasoning=0, total=504, tps=50
[16:02:10] [INFO]   |-- requests: success=4, failed=0, total=4, rpm=24
[16:02:10] [INFO] 📐 Measuring dataset column statistics:
[16:02:10] [INFO]   |-- 🎲 column: 'product_category'
[16:02:10] [INFO]   |-- 🎲 column: 'product_subcategory'
[16:02:10] [INFO]   |-- 🎲 column: 'target_age_range'
[16:02:10] [INFO]   |-- 🎲 column: 'customer'
[16:02:10] [INFO]   |-- 🎲 column: 'number_of_stars'
[16:02:10] [INFO]   |-- 🎲 column: 'review_style'
[16:02:10] [INFO]   |-- 📝 column: 'product_name'
[16:02:10] [INFO]   |-- 📝 column: 'customer_review'
[16:02:10] [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    │ Home Office                                                                          │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ product_subcategory │ Lighting                                                                             │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ target_age_range    │ 18-25                                                                                │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ customer            │ {                                                                                    │
│                     │     'uuid': '93b10199-2c03-4277-bc64-8f5192dcdf04',                                  │
│                     │     'locale': 'en_US',                                                               │
│                     │     'first_name': 'Teresa',                                                          │
│                     │     'last_name': 'Smith',                                                            │
│                     │     'middle_name': None,                                                             │
│                     │     'sex': 'Female',                                                                 │
│                     │     'street_number': '57930',                                                        │
│                     │     'street_name': 'Sullivan Expressway',                                            │
│                     │     'city': 'New Maria',                                                             │
│                     │     'state': 'Oklahoma',                                                             │
│                     │     'postcode': '31532',                                                             │
│                     │     'age': 18,                                                                       │
│                     │     'birth_date': '2007-11-20',                                                      │
│                     │     'country': 'Bahamas',                                                            │
│                     │     'marital_status': 'never_married',                                               │
│                     │     'education_level': 'bachelors',                                                  │
│                     │     'unit': '',                                                                      │
│                     │     'occupation': 'Restaurant manager',                                              │
│                     │     'phone_number': '+1-726-903-2636',                                               │
│                     │     'bachelors_field': 'education'                                                   │
│                     │ }                                                                                    │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ number_of_stars     │ 4                                                                                    │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ review_style        │ structured with bullet points                                                        │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ product_name        │ PulseShift Work Light                                                                │
├─────────────────────┼──────────────────────────────────────────────────────────────────────────────────────┤
│ customer_review     │ • Bought the PulseShift Work Light last week and it has completely transformed my    │
│                     │ late-night study sessions.                                                           │
│                     │ • The adjustable brightness settings are perfect; I can dim it just enough to not    │
│                     │ strain my eyes, but bright enough to see my notes clearly.                           │
│                     │ • Battery life is impressive—I’ve used it for hours on a single charge and it’s      │
│                     │ still going strong.                                                                  │
│                     │ • The clip-on design is sturdy and holds onto my desk lamp without slipping, which   │
│                     │ is exactly what I needed.                                                            │
│                     │ • Would definitely recommend it to fellow students; great value for the price and    │
│                     │ performance.                                                                         │
└─────────────────────┴──────────────────────────────────────────────────────────────────────────────────────┘
                                                                                                              
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 Home Office Lighting 18-25 {'uuid': '93b10199-2c03-4277-bc64-8f5192dcdf04... 4 structured with bullet points PulseShift Work Light • Bought the PulseShift Work Light last week a...
1 Home Office Office Supplies 50-65 {'uuid': '5a3b78b0-adb8-4eac-8639-a230763c75a7... 1 brief Blueprints Office Companion Bought this hoping for useful office help, but...

📊 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 │                       1 (50.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 │                      2 (100.0%) │                    uniform │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ review_style                   │          string │                      2 (100.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.0 +/- 0.0 │            4.5 +/- 0.7 │
├───────────────────────┼───────────────┼────────────────────────────┼───────────────────┼────────────────────────┤
│ customer_review       │        string │                 2 (100.0%) │      69.5 +/- 0.5 │          67.0 +/- 62.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
[16:02:10] [INFO] OpenTelemetry metrics available at http://127.0.0.1:9464/metrics
[16:02:10] [INFO] 🎨 Creating Data Designer dataset
[16:02:10] [INFO]   |-- 🔒 Jinja rendering engine: secure
[16:02:10] [INFO] ✅ Validation passed
[16:02:10] [INFO] ⛓️ Sorting column configs into a Directed Acyclic Graph
[16:02:10] [INFO] Skipping model health checks because DATA_DESIGNER_SKIP_MODEL_HEALTH_CHECKS=1
[16:02:10] [INFO] ⚡ Using async task-queue builder
[16:02:10] [INFO] 📝 llm-text model config for column 'product_name'
[16:02:10] [INFO]   |-- model: 'nvidia/nemotron-3.5-lightning-30b-a3b'
[16:02:10] [INFO]   |-- model alias: 'nemotron-lightning'
[16:02:10] [INFO]   |-- model provider: 'nvidia'
[16:02:10] [INFO]   |-- inference parameters:
[16:02:10] [INFO]   |  |-- generation_type=chat-completion
[16:02:10] [INFO]   |  |-- max_parallel_requests=4
[16:02:10] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[16:02:10] [INFO]   |  |-- temperature=1.00
[16:02:10] [INFO]   |  |-- top_p=0.95
[16:02:10] [INFO]   |  |-- max_tokens=2048
[16:02:10] [INFO] 📝 llm-text model config for column 'customer_review'
[16:02:10] [INFO]   |-- model: 'nvidia/nemotron-3.5-lightning-30b-a3b'
[16:02:10] [INFO]   |-- model alias: 'nemotron-lightning'
[16:02:10] [INFO]   |-- model provider: 'nvidia'
[16:02:10] [INFO]   |-- inference parameters:
[16:02:10] [INFO]   |  |-- generation_type=chat-completion
[16:02:10] [INFO]   |  |-- max_parallel_requests=4
[16:02:10] [INFO]   |  |-- extra_body={'chat_template_kwargs': {'enable_thinking': False}}
[16:02:10] [INFO]   |  |-- temperature=1.00
[16:02:10] [INFO]   |  |-- top_p=0.95
[16:02:10] [INFO]   |  |-- max_tokens=2048
[16:02:10] [INFO] ⚡️ Async generation: 2 column(s) (column 'product_name', column 'customer_review'), 20 tasks across 1 row group(s)
[16:02:10] [INFO] 🚀 (1/1) Dispatching with 10 records
[16:02:10] [INFO] 🎲 (1/1) Preparing samplers to generate 10 records across 6 columns
[16:02:11] [WARNING] Observed retryable model-task error: kind=rate_limit, http_status=429; the row task will be deferred.
[16:02:16] [INFO] 📊 Progress [6.1s]:
[16:02:16] [INFO]   |-- 🌤️ column 'product_name': 9/10 (90%) 1.5 rec/s
[16:02:16] [INFO]   |-- 🌦️ column 'customer_review': 4/10 (40%) 0.7 rec/s
[16:02:25] [INFO] 📊 Progress [14.2s]:
[16:02:25] [INFO]   |-- 🌤️ column 'product_name': 9/10 (90%) 0.6 rec/s
[16:02:25] [INFO]   |-- ⛅ column 'customer_review': 5/10 (50%) 0.4 rec/s
[16:02:30] [INFO] 📊 Progress [19.5s]:
[16:02:30] [INFO]   |-- 🌤️ column 'product_name': 9/10 (90%) 0.5 rec/s
[16:02:30] [INFO]   |-- ⛅ column 'customer_review': 7/10 (70%) 0.4 rec/s
[16:02:30] [INFO] 🔄 (1/1) Salvaging 3 deferred task(s)
[16:02:40] [INFO] 📊 Progress [29.6s]:
[16:02:40] [INFO]   |-- 🌤️ column 'product_name': 9/10 (90%) 0.3 rec/s
[16:02:40] [INFO]   |-- 🌤️ column 'customer_review': 8/10 (80%) 0.3 rec/s
[16:02:40] [INFO] 🔄 (1/1) Preserving 2 retryable task(s); records will keep retrying.
[16:02:48] [INFO] 📊 Progress [37.4s]:
[16:02:48] [INFO]   |-- 🌤️ column 'product_name': 9/10 (90%) 0.2 rec/s
[16:02:48] [INFO]   |-- 🌤️ column 'customer_review': 9/10 (90%) 0.2 rec/s
[16:02:48] [INFO] 🔄 (1/1) Preserving 1 retryable task(s); records will keep retrying.
[16:02:50] [WARNING] Provider showing degraded performance: 50% of last 20 task outcomes were retryable errors (rate_limit=10, success=10); cumulative outcomes: rate_limit=11, success=18; deferred_tasks=1. Run may take longer than expected; salvage will retry these.
[16:03:03] [INFO] 📊 Progress [52.2s]:
[16:03:03] [INFO]   |-- ☀️ column 'product_name': 10/10 (100%) 0.2 rec/s
[16:03:03] [INFO]   |-- 🌤️ column 'customer_review': 9/10 (90%) 0.2 rec/s
[16:03:07] [INFO] 📊 Progress [56.4s]:
[16:03:07] [INFO]   |-- ☀️ column 'product_name': 10/10 (100%) 0.2 rec/s
[16:03:07] [INFO]   |-- ☀️ column 'customer_review': 10/10 (100%) 0.2 rec/s
[16:03:07] [INFO] ✅ Async generation complete [56.4s]: 20 ok, 0 failed across 2 column(s)
[16:03:07] [INFO] 📊 Model usage summary:
[16:03:07] [INFO]   |-- model: nvidia/nemotron-3.5-lightning-30b-a3b
[16:03:07] [INFO]   |-- tokens: input=1773, output=2461, reasoning=0, total=4234, tps=74
[16:03:07] [INFO]   |-- requests: success=20, failed=16, total=36, rpm=38
[16:03:07] [INFO] 📐 Measuring dataset column statistics:
[16:03:07] [INFO]   |-- 🎲 column: 'product_category'
[16:03:07] [INFO]   |-- 🎲 column: 'product_subcategory'
[16:03:07] [INFO]   |-- 🎲 column: 'target_age_range'
[16:03:07] [INFO]   |-- 🎲 column: 'customer'
[16:03:07] [INFO]   |-- 🎲 column: 'number_of_stars'
[16:03:07] [INFO]   |-- 🎲 column: 'review_style'
[16:03:07] [INFO]   |-- 📝 column: 'product_name'
[16:03:07] [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 35-50 {'uuid': '28f4ef0c-0b65-41b4-913b-e7045093b80a... 1 rambling Obsidian Overcoat So I went and I bought this coat, the Obsidian...
1 Clothing Men's Clothing 25-35 {'uuid': '62b901c4-db9e-4ca3-9d20-002a19be7a49... 4 rambling Urban Nomad Jacket Okay so I decided to pull the trigger on this ...
2 Clothing Winter Coats 35-50 {'uuid': '27e5d786-af0f-429f-8295-9c11a9e426f0... 2 brief The Aurora Shift Coat The material feels cheap and flimsy. The fit i...
3 Home & Kitchen Decor 18-25 {'uuid': 'a1bc206f-5024-4e85-8da0-48477925bddd... 2 detailed MoodLights I have to be honest, installing these MoodLigh...
4 Home & Kitchen Organization 50-65 {'uuid': 'c12b104b-2db6-4d50-bf93-dec95a6575f8... 4 brief Timeless Tidy Organizer Purchased the Timeless Tidy Organizer recently...
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 │                       4 (40.0%) │                   category │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ product_subcategory            │          string │                       8 (80.0%) │                subcategory │
├────────────────────────────────┼─────────────────┼─────────────────────────────────┼────────────────────────────┤
│ target_age_range               │          string │                       4 (40.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.5 +/- 0.8 │            4.0 +/- 0.7 │
├───────────────────────┼───────────────┼────────────────────────────┼───────────────────┼────────────────────────┤
│ customer_review       │        string │                10 (100.0%) │      68.5 +/- 1.7 │        218.5 +/- 146.3 │
└───────────────────────┴───────────────┴────────────────────────────┴───────────────────┴────────────────────────┘
                                                                                                                   
                                                                                                                   
╭────────────────────────────────────────────────── 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: