DataDesigner/docs/code_reference/config/analysis.md
Andre Manoel 8b79b21298 Initialize orphan Fern docs website branch
Preserves tree from previous docs-website head: 5e47d33ea8. This branch is a CI-managed publish artifact like gh-pages; source provenance is tracked in commit messages rather than Git ancestry.
2026-05-14 01:17:51 +00:00

1.4 KiB

Analysis

Profiling result objects and report helpers returned after generation.

Column Statistics

DataDesigner.create() and DataDesigner.preview() run the dataset profiler after generation. The profiler computes statistics for each configured column; side-effect columns are recorded separately in DatasetProfilerResults.side_effect_column_names.

Statistics result classes store computed metrics for each column type and format those metrics for reports.

::: data_designer.config.analysis.column_statistics

Column Profilers

Column profilers are optional analysis tools that provide deeper insights into specific column types. Currently, the only column profiler available is the Judge Score Profiler.

Profiler result classes store computed profiler output and format it for reports.

::: data_designer.config.analysis.column_profilers

Dataset Profiler

The DatasetProfilerResults class stores profiling results for a generated dataset. It aggregates column-level statistics, side-effect column names, and optional profiler results, and provides methods to:

  • Compute dataset-level metrics (completion percentage, column type summary)
  • Filter statistics by column type
  • Generate formatted analysis reports via the to_report() method

Reports can be displayed in the console or exported to HTML/SVG formats.

::: data_designer.config.analysis.dataset_profiler