> 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.analysis.utils.reporting

## Module Contents

### Classes

| Name                                                                       | Description                                                                 |
| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [`ReportSection`](#data_designerconfiganalysisutilsreportingreportsection) | str(object='') -> str str(bytes\_or\_buffer\[, encoding\[, errors]]) -> str |

### Functions

| Name                                                                                                             | Description                                                |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [`generate_analysis_report`](#data_designerconfiganalysisutilsreportinggenerate_analysis_report)                 | Generate an analysis report for dataset profiling results. |
| [`create_judge_score_summary_table`](#data_designerconfiganalysisutilsreportingcreate_judge_score_summary_table) | None                                                       |

### Data

[`HEADER_STYLE`](#data_designerconfiganalysisutilsreportingheader_style)
[`RULE_STYLE`](#data_designerconfiganalysisutilsreportingrule_style)
[`ACCENT_STYLE`](#data_designerconfiganalysisutilsreportingaccent_style)
[`TITLE_STYLE`](#data_designerconfiganalysisutilsreportingtitle_style)
[`HIST_NAME_STYLE`](#data_designerconfiganalysisutilsreportinghist_name_style)
[`HIST_VALUE_STYLE`](#data_designerconfiganalysisutilsreportinghist_value_style)
[`DEFAULT_INCLUDE_SECTIONS`](#data_designerconfiganalysisutilsreportingdefault_include_sections)

### API

```python
HEADER_STYLE = dim
```

```python
RULE_STYLE
```

```python
ACCENT_STYLE
```

```python
TITLE_STYLE
```

```python
HIST_NAME_STYLE
```

```python
HIST_VALUE_STYLE
```

```python
class data_designer.config.analysis.utils.reporting.ReportSection
```

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

```python
OVERVIEW = overview
```

```python
COLUMN_PROFILERS = column_profilers
```

```python
DEFAULT_INCLUDE_SECTIONS
```

```python
data_designer.config.analysis.utils.reporting.generate_analysis_report(
    analysis: data_designer.config.analysis.dataset_profiler.DatasetProfilerResults,
    save_path: str | pathlib.Path | None = None,
    include_sections: list[data_designer.config.analysis.utils.reporting.ReportSection | data_designer.config.column_types.DataDesignerColumnType] | None = None
) -> None
```

Generate an analysis report for dataset profiling results.

This function creates a rich-formatted report that displays dataset overview statistics
and detailed column statistics organized by column type. The report includes visual
elements like tables, rules, and panels to present the analysis results in an
easy-to-read format.

**Parameters:**

The DatasetProfilerResults object containing the analysis data to report on.

Optional path to save the report. If provided, the report will be saved
as either HTML (.html) or SVG (.svg) format. If None, the report will
only be displayed in the console.

Optional list of sections to include in the report. Choices are
any Data Designer column type, "overview" (the dataset overview section),
and "column\_profilers" (all column profilers in one section). If None,
all sections will be included.

**Raises:**

If save\_path is provided but doesn't have a .html or .svg extension.

```python
data_designer.config.analysis.utils.reporting.create_judge_score_summary_table(
    score_name: str,
    histogram: data_designer.config.analysis.column_statistics.CategoricalHistogramData,
    summary: str,
    accent_style: str = ACCENT_STYLE,
    summary_border_style: str = 'dim'
) -> rich.table.Table
```