data_designer.config.analysis.utils.reporting

Module Contents

Classes

Name	Description
`ReportSection`	str(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Functions

Name	Description
`generate_analysis_report`	Generate an analysis report for dataset profiling results.
`create_judge_score_summary_table`	None

Data

HEADER_STYLE RULE_STYLE ACCENT_STYLE TITLE_STYLE HIST_NAME_STYLE HIST_VALUE_STYLE DEFAULT_INCLUDE_SECTIONS

API

1 HEADER_STYLE = dim

1 RULE_STYLE

1 ACCENT_STYLE

1 TITLE_STYLE

1 HIST_NAME_STYLE

1 HIST_VALUE_STYLE

1 class data_designer.config.analysis.utils.reporting.ReportSection

Bases: str, enum.Enum

1 OVERVIEW = overview

1 COLUMN_PROFILERS = column_profilers

1 DEFAULT_INCLUDE_SECTIONS

1 data_designer.config.analysis.utils.reporting.generate_analysis_report(
2     analysis: data_designer.config.analysis.dataset_profiler.DatasetProfilerResults,
3     save_path: str | pathlib.Path | None = None,
4     include_sections: list[data_designer.config.analysis.utils.reporting.ReportSection | data_designer.config.column_types.DataDesignerColumnType] | None = None    include_sections: list[data_designer.config.analysis.utils.reporting.ReportSection | data_designer.config.column_types.DataDesignerColumnType] | None = None
5 ) -> 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:

analysis

data_designer.config.analysis.dataset_profiler.DatasetProfilerResults

The DatasetProfilerResults object containing the analysis data to report on.

save_path

str | pathlib.Path | NoneDefaults to None

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.

include_sections

list[data_designer.config.analysis.utils.reporting.ReportSection | data_designer.config.column_types.DataDesignerColumnType] | NoneDefaults to None

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:

AnalysisReportError

If save_path is provided but doesn’t have a .html or .svg extension.

1 data_designer.config.analysis.utils.reporting.create_judge_score_summary_table(
2     score_name: str,
3     histogram: data_designer.config.analysis.column_statistics.CategoricalHistogramData,
4     summary: str,
5     accent_style: str = ACCENT_STYLE,
6     summary_border_style: str = 'dim'
7 ) -> rich.table.Table

1	data_designer.config.analysis.utils.reporting.generate_analysis_report(
2	analysis: data_designer.config.analysis.dataset_profiler.DatasetProfilerResults,
3	save_path: str \| pathlib.Path \| None = None,
4	include_sections: list[data_designer.config.analysis.utils.reporting.ReportSection \| data_designer.config.column_types.DataDesignerColumnType] \| None = None include_sections: list[data_designer.config.analysis.utils.reporting.ReportSection \| data_designer.config.column_types.DataDesignerColumnType] \| None = None
5	) -> None

1	data_designer.config.analysis.utils.reporting.create_judge_score_summary_table(
2	score_name: str,
3	histogram: data_designer.config.analysis.column_statistics.CategoricalHistogramData,
4	summary: str,
5	accent_style: str = ACCENT_STYLE,
6	summary_border_style: str = 'dim'
7	) -> rich.table.Table