For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Welcome
    • Contributing
  • Concepts
    • Columns
    • Seed Datasets
    • Agent Rollout Ingestion
    • Custom Columns
    • Validators
    • Processors
    • Person Sampling
    • Traces
    • Architecture & Performance
    • Deployment Options
    • Security
  • Tutorials
    • Overview
    • The Basics
    • Structured Outputs, Jinja Expressions, and Conditional Generation
    • Seeding with an External Dataset
    • Providing Images as Context
    • Generating Images
    • Image-to-Image Editing
  • Recipes
    • Recipe Cards
  • Plugins
    • Overview
    • Example Plugin
    • FileSystemSeedReader Plugins
    • Discover
  • Code Reference
    • Overview
      • Overview
      • models
      • mcp
      • column_configs
      • config_builder
      • data_designer_config
      • run_config
      • sampler_params
      • validator_params
      • seeds
      • processors
      • analysis
      • Config API
        • Analysis
        • Base
        • Column Configs
        • Column Types
        • Config Builder
        • Custom Column
        • Data Designer Config
        • Dataset Metadata
        • Default Model Settings
        • Errors
        • Exportable Config
        • Fingerprint
        • Interface
        • Mcp
        • Models
        • Preview Results
        • Processor Types
        • Processors
        • Run Config
        • Sampler Constraints
        • Sampler Params
        • Seed
        • Seed Source
        • Seed Source Dataframe
        • Seed Source Types
        • Testing
        • Utils
          • Code Lang
          • Constants
          • Errors
          • Image Helpers
          • Info
          • Io Helpers
          • Misc
          • Numerical Helpers
          • Trace Renderer
          • Trace Type
          • Type Helpers
          • Visualization
          • Warning Helpers
        • Validator Params
        • Version
  • Dev Notes
    • Overview
    • Prompt Sensitivity
    • Retriever SDG Toolkit
    • Have It Your Way
    • VLM Long Document Understanding
    • Push Datasets to Hugging Face Hub
    • Text-to-SQL for Nemotron Super
    • Async All the Way Down
    • Owning the Model Stack
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Manage My Privacy | Do Not Sell or Share My Data | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogoNeMo Data Designer
On this page
  • Module Contents
  • Classes
  • Functions
  • Data
  • API
Code ReferenceConfigConfig APIUtils

data_designer.config.utils.visualization

||View as Markdown|
Previous

Type Helpers

Next

Warning Helpers

Module Contents

Classes

NameDescription
ColorPalettestr(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
WithRecordSamplerMixinNone

Functions

NameDescription
_display_notebook_htmlDisplay raw HTML in a Jupyter notebook. Returns True if displayed.
_display_image_if_in_notebookDisplay image with caption in Jupyter notebook if available.
get_nvidia_api_keyNone
get_openai_api_keyNone
create_rich_histogram_tableNone
display_sample_recordNone
get_truncated_list_as_stringNone
display_sampler_tableNone
display_model_configs_tableNone
display_model_providers_tableNone
mask_api_keyMask API keys for display.
convert_to_row_elementNone
pad_console_elementNone
_get_field_typeExtract human-readable type information from a JSON Schema field.
_get_field_constraintsExtract human-readable constraints from a JSON Schema field.
apply_html_post_processingInject viewport meta tag and optional dark-mode CSS into a Rich-exported HTML file.
_save_console_outputNone

Data

console logger _DEDICATED_DISPLAY_COL_TYPES _LLM_COLUMN_TYPES _SAMPLE_RECORD_DARK_CSS

API

1console = Console(...)
1logger = getLogger(...)
1_DEDICATED_DISPLAY_COL_TYPES
1_LLM_COLUMN_TYPES
1data_designer.config.utils.visualization._display_notebook_html(html_content: str) -> bool

Display raw HTML in a Jupyter notebook. Returns True if displayed.

1data_designer.config.utils.visualization._display_image_if_in_notebook(
2 image_data: str,
3 col_name: str
4) -> bool

Display image with caption in Jupyter notebook if available.

Parameters:

image_data
str

Base64-encoded image data, data URI, file path, or URL.

col_name
str

Name of the column (used for caption).

Returns:

bool

True if image was displayed, False otherwise.

1data_designer.config.utils.visualization.get_nvidia_api_key() -> str | None
1data_designer.config.utils.visualization.get_openai_api_key() -> str | None
1class data_designer.config.utils.visualization.ColorPalette

Bases: str, enum.Enum

1NVIDIA_GREEN = #76b900
1PURPLE = #9525c6
1YELLOW = #f9c500
1BLUE = #0074df
1RED = #e52020
1ORANGE = #ef9100
1MAGENTA = #d2308e
1TEAL = #1dbba4
1class data_designer.config.utils.visualization.WithRecordSamplerMixin
1_display_cycle_index: int = 0
1dataset_metadata: data_designer.config.dataset_metadata.DatasetMetadata | None
1_record_sampler_dataset() -> pandas.DataFrame
1_has_processor_artifacts() -> bool
1display_sample_record(
2 index: int | None = None,
3 *,
4 syntax_highlighting_theme: str = 'dracula',
5 background_color: str | None = None,
6 processors_to_display: list[str] | None = None,
7 hide_seed_columns: bool = False,
8 include_traces: bool = True,
9 save_path: str | pathlib.Path | None = None,
10 theme: typing.Literal[dark, light] = 'dark',
11 display_width: int = DEFAULT_DISPLAY_WIDTH
12) -> None

Display a sample record from the Data Designer dataset preview.

Parameters:

index
int | NoneDefaults to None

Index of the record to display. If None, the next record will be displayed. This is useful for running the cell in a notebook multiple times.

syntax_highlighting_theme
strDefaults to 'dracula'

Theme to use for syntax highlighting. See the Syntax documentation from rich for information about available themes.

background_color
str | NoneDefaults to None

Background color to use for the record. See the Syntax documentation from rich for information about available background colors.

processors_to_display
list[str] | NoneDefaults to None

List of processors to display the artifacts for. If None, all processors will be displayed.

hide_seed_columns
boolDefaults to False

If True, seed columns will not be displayed separately.

include_traces
boolDefaults to True

If True (default), render LLM conversation traces when trace columns are present. Set to False to suppress trace display.

save_path
str | pathlib.Path | NoneDefaults to None

Optional path to save the rendered output as an HTML or SVG file.

theme
typing.Literal[dark, light]Defaults to 'dark'

Color theme for saved HTML files (dark or light).

display_width
intDefaults to DEFAULT_DISPLAY_WIDTH

Width of the rendered output in characters.

1data_designer.config.utils.visualization.create_rich_histogram_table(
2 data: dict[str, int | float],
3 column_names: tuple[int, int],
4 name_style: str = ColorPalette.BLUE.value,
5 value_style: str = ColorPalette.TEAL.value,
6 title: str | None = None,
7 **kwargs
8) -> rich.table.Table
1data_designer.config.utils.visualization.display_sample_record(
2 record: dict | pandas.Series | pandas.DataFrame,
3 config_builder: data_designer.config.config_builder.DataDesignerConfigBuilder,
4 processor_data_to_display: dict[str, list[str] | str] | None = None,
5 background_color: str | None = None,
6 syntax_highlighting_theme: str = 'dracula',
7 record_index: int | None = None,
8 seed_column_names: list[str] | None = None,
9 include_traces: bool = True,
10 save_path: str | pathlib.Path | None = None,
11 theme: typing.Literal[dark, light] = 'dark',
12 display_width: int = DEFAULT_DISPLAY_WIDTH
13) -> None
1data_designer.config.utils.visualization.get_truncated_list_as_string(
2 long_list: list[typing.Any],
3 max_items: int = 2
4) -> str
1data_designer.config.utils.visualization.display_sampler_table(
2 sampler_params: dict[data_designer.config.sampler_params.SamplerType, data_designer.config.base.ConfigBase], sampler_params: dict[data_designer.config.sampler_params.SamplerType, data_designer.config.base.ConfigBase],
3 title: str | None = None
4) -> None
1data_designer.config.utils.visualization.display_model_configs_table(model_configs: list[data_designer.config.models.ModelConfig]) -> None
1data_designer.config.utils.visualization.display_model_providers_table(model_providers: list[data_designer.config.models.ModelProvider]) -> None
1data_designer.config.utils.visualization.mask_api_key(api_key: str | None) -> str

Mask API keys for display.

Environment variable names (all uppercase) are kept visible. Actual API keys are masked to show only the last 4 characters.

Parameters:

api_key
str | None

The API key to mask.

Returns:

str

Masked API key string or “(not set)” if None.

1data_designer.config.utils.visualization.convert_to_row_element(elem: typing.Any) -> str | rich.pretty.Pretty
1data_designer.config.utils.visualization.pad_console_element(
2 elem: typing.Any,
3 padding: tuple[int, int, int, int] = (1, 0, 1, 0)
4) -> rich.padding.Padding
1data_designer.config.utils.visualization._get_field_type(field: dict) -> str

Extract human-readable type information from a JSON Schema field.

1data_designer.config.utils.visualization._get_field_constraints(
2 field: dict,
3 schema: dict
4) -> str

Extract human-readable constraints from a JSON Schema field.

1_SAMPLE_RECORD_DARK_CSS =
2:root { color-scheme: dark; }
3html, body { background: #020a1d !important; color: #dbe8ff !important; }
4pre, code { color: inherit !important; }
5table, th, td { border-color: rgba(184, 210, 255, 0.5) !important; }
1data_designer.config.utils.visualization.apply_html_post_processing(
2 html_path: str | pathlib.Path,
3 *,
4 theme: typing.Literal[dark, light] = 'dark'
5) -> None

Inject viewport meta tag and optional dark-mode CSS into a Rich-exported HTML file.

1data_designer.config.utils.visualization._save_console_output(
2 recorded_console: rich.console.Console,
3 save_path: str | pathlib.Path,
4 *,
5 theme: typing.Literal[dark, light] = 'dark'
6) -> None