> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/datadesigner/llms.txt.
> For full documentation content, see https://docs.nvidia.com/nemo/datadesigner/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/datadesigner/_mcp/server.

# data\_designer.config.utils.visualization

## Module Contents

### Classes

| Name                                                                                     | Description                                                                 |
| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [`ColorPalette`](#data_designerconfigutilsvisualizationcolorpalette)                     | str(object='') -> str str(bytes\_or\_buffer\[, encoding\[, errors]]) -> str |
| [`WithRecordSamplerMixin`](#data_designerconfigutilsvisualizationwithrecordsamplermixin) | None                                                                        |

### Functions

| Name                                                                                                   | Description                                                                         |
| ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
| [`_display_notebook_html`](#data_designerconfigutilsvisualization_display_notebook_html)               | Display raw HTML in a Jupyter notebook. Returns True if displayed.                  |
| [`_display_image_if_in_notebook`](#data_designerconfigutilsvisualization_display_image_if_in_notebook) | Display image with caption in Jupyter notebook if available.                        |
| [`get_nvidia_api_key`](#data_designerconfigutilsvisualizationget_nvidia_api_key)                       | None                                                                                |
| [`get_openai_api_key`](#data_designerconfigutilsvisualizationget_openai_api_key)                       | None                                                                                |
| [`create_rich_histogram_table`](#data_designerconfigutilsvisualizationcreate_rich_histogram_table)     | None                                                                                |
| [`display_sample_record`](#data_designerconfigutilsvisualizationdisplay_sample_record)                 | None                                                                                |
| [`get_truncated_list_as_string`](#data_designerconfigutilsvisualizationget_truncated_list_as_string)   | None                                                                                |
| [`display_sampler_table`](#data_designerconfigutilsvisualizationdisplay_sampler_table)                 | None                                                                                |
| [`display_model_configs_table`](#data_designerconfigutilsvisualizationdisplay_model_configs_table)     | None                                                                                |
| [`display_model_providers_table`](#data_designerconfigutilsvisualizationdisplay_model_providers_table) | None                                                                                |
| [`mask_api_key`](#data_designerconfigutilsvisualizationmask_api_key)                                   | Mask API keys for display.                                                          |
| [`convert_to_row_element`](#data_designerconfigutilsvisualizationconvert_to_row_element)               | None                                                                                |
| [`pad_console_element`](#data_designerconfigutilsvisualizationpad_console_element)                     | None                                                                                |
| [`_get_field_type`](#data_designerconfigutilsvisualization_get_field_type)                             | Extract human-readable type information from a JSON Schema field.                   |
| [`_get_field_constraints`](#data_designerconfigutilsvisualization_get_field_constraints)               | Extract human-readable constraints from a JSON Schema field.                        |
| [`apply_html_post_processing`](#data_designerconfigutilsvisualizationapply_html_post_processing)       | Inject viewport meta tag and optional dark-mode CSS into a Rich-exported HTML file. |
| [`_save_console_output`](#data_designerconfigutilsvisualization_save_console_output)                   | None                                                                                |

### Data

[`console`](#data_designerconfigutilsvisualizationconsole)
[`logger`](#data_designerconfigutilsvisualizationlogger)
[`_DEDICATED_DISPLAY_COL_TYPES`](#data_designerconfigutilsvisualization_dedicated_display_col_types)
[`_LLM_COLUMN_TYPES`](#data_designerconfigutilsvisualization_llm_column_types)
[`_SAMPLE_RECORD_DARK_CSS`](#data_designerconfigutilsvisualization_sample_record_dark_css)

### API

```python
console = Console(...)
```

```python
logger = getLogger(...)
```

```python
_DEDICATED_DISPLAY_COL_TYPES
```

```python
_LLM_COLUMN_TYPES
```

```python
data_designer.config.utils.visualization._display_notebook_html(html_content: str) -> bool
```

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

```python
data_designer.config.utils.visualization._display_image_if_in_notebook(
    image_data: str,
    col_name: str
) -> bool
```

Display image with caption in Jupyter notebook if available.

**Parameters:**

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

Name of the column (used for caption).

**Returns:**

`bool`

True if image was displayed, False otherwise.

```python
data_designer.config.utils.visualization.get_nvidia_api_key() -> str | None
```

```python
data_designer.config.utils.visualization.get_openai_api_key() -> str | None
```

```python
class data_designer.config.utils.visualization.ColorPalette
```

**Bases**: `str`, `enum.Enum`

```python
NVIDIA_GREEN = #76b900
```

```python
PURPLE = #9525c6
```

```python
YELLOW = #f9c500
```

```python
BLUE = #0074df
```

```python
RED = #e52020
```

```python
ORANGE = #ef9100
```

```python
MAGENTA = #d2308e
```

```python
TEAL = #1dbba4
```

```python
class data_designer.config.utils.visualization.WithRecordSamplerMixin
```

```python
_display_cycle_index: int = 0
```

```python
dataset_metadata: data_designer.config.dataset_metadata.DatasetMetadata | None
```

```python
_record_sampler_dataset() -> pandas.DataFrame
```

```python
_has_processor_artifacts() -> bool
```

```python
display_sample_record(
    index: int | None = None,
    *,
    syntax_highlighting_theme: str = 'dracula',
    background_color: str | None = None,
    processors_to_display: list[str] | None = None,
    hide_seed_columns: bool = False,
    include_traces: bool = True,
    save_path: str | pathlib.Path | None = None,
    theme: typing.Literal[dark, light] = 'dark',
    display_width: int = DEFAULT_DISPLAY_WIDTH
) -> None
```

Display a sample record from the Data Designer dataset preview.

**Parameters:**

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.

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

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

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

If True, seed columns will not be displayed separately.

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

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

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

Width of the rendered output in characters.

```python
data_designer.config.utils.visualization.create_rich_histogram_table(
    data: dict[str, int | float],
    column_names: tuple[int, int],
    name_style: str = ColorPalette.BLUE.value,
    value_style: str = ColorPalette.TEAL.value,
    title: str | None = None,
    **kwargs
) -> rich.table.Table
```

```python
data_designer.config.utils.visualization.display_sample_record(
    record: dict | pandas.Series | pandas.DataFrame,
    config_builder: data_designer.config.config_builder.DataDesignerConfigBuilder,
    processor_data_to_display: dict[str, list[str] | str] | None = None,
    background_color: str | None = None,
    syntax_highlighting_theme: str = 'dracula',
    record_index: int | None = None,
    seed_column_names: list[str] | None = None,
    include_traces: bool = True,
    save_path: str | pathlib.Path | None = None,
    theme: typing.Literal[dark, light] = 'dark',
    display_width: int = DEFAULT_DISPLAY_WIDTH
) -> None
```

```python
data_designer.config.utils.visualization.get_truncated_list_as_string(
    long_list: list[typing.Any],
    max_items: int = 2
) -> str
```

```python
data_designer.config.utils.visualization.display_sampler_table(
    sampler_params: dict[data_designer.config.sampler_params.SamplerType, data_designer.config.base.ConfigBase],
    title: str | None = None
) -> None
```

```python
data_designer.config.utils.visualization.display_model_configs_table(model_configs: list[data_designer.config.models.ModelConfig]) -> None
```

```python
data_designer.config.utils.visualization.display_model_providers_table(model_providers: list[data_designer.config.models.ModelProvider]) -> None
```

```python
data_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:**

The API key to mask.

**Returns:**

`str`

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

```python
data_designer.config.utils.visualization.convert_to_row_element(elem: typing.Any) -> str | rich.pretty.Pretty
```

```python
data_designer.config.utils.visualization.pad_console_element(
    elem: typing.Any,
    padding: tuple[int, int, int, int] = (1, 0, 1, 0)
) -> rich.padding.Padding
```

```python
data_designer.config.utils.visualization._get_field_type(field: dict) -> str
```

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

```python
data_designer.config.utils.visualization._get_field_constraints(
    field: dict,
    schema: dict
) -> str
```

Extract human-readable constraints from a JSON Schema field.

```python
_SAMPLE_RECORD_DARK_CSS = 
:root { color-scheme: dark; }
html, body { background: #020a1d !important; color: #dbe8ff !important; }
pre, code { color: inherit !important; }
table, th, td { border-color: rgba(184, 210, 255, 0.5) !important; }

```

```python
data_designer.config.utils.visualization.apply_html_post_processing(
    html_path: str | pathlib.Path,
    *,
    theme: typing.Literal[dark, light] = 'dark'
) -> None
```

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

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