SyntheticCheck.get_tabular_report()

Get a tabular report of the checks of the synthetic data.

Usage

SyntheticCheck.get_tabular_report(
    title=None,
    lang=None,
    locale=None,
)

The report has a group of rows for each check: the fidelity of each column, the diversity of the rows and of the text, and the copies of seed rows. Each row has a badge with its result, and the header says how many issues there are.

Parameters

title: str | None = None: An optional title replacing the default.
lang: str | None = None: The language of the report’s text, as a two-letter language code (e.g., "fr" or "de"; see the lang= argument of Validate for the languages). By default, the report is in English. The names of the columns are shown as they are.
locale: str | None = None: The locale for the numbers in the report (e.g., "de-CH"), which sets the decimal mark and the thousands separator. By default, it’s lang=.

Returns

GT: A Great Tables object.

Examples

import pointblank as pb
import polars as pl

seed = pl.DataFrame({"x": list(range(100)), "y": ["a", "b"] * 50})
synthetic = pl.DataFrame({"x": [k % 10 for k in range(100)], "y": ["a", "b"] * 50})

pb.check_synthetic(synthetic, seed).get_tabular_report()

Check	Result
Synthetic data check
synthetic: 100 rows · seed: 100 rows 3 issues found.
Fidelity
`x` compared with the seed	MAJOR PSI 8.28 numeric; KS 0.9 (p = 0); missing 0.0% (the seed: 0.0%)
`y` compared with the seed	STABLE PSI 0 categorical; missing 0.0% (the seed: 0.0%)
Diversity
Rows that repeat an earlier row compared on `x`, `y`	MORE 90 of 100 rows (90.0%) the seed: 0 of 100 rows (0.0%)
Copies
Synthetic rows that copy a seed row compared on `x`, `y`	COPIES 100 of 100 rows (100.0%) 100 the same
PSI is the population stability index of the shares of the values (binned by the deciles of the seed, for a numeric column): a change is moderate from 0.1 and major from 0.2. KS is the Kolmogorov-Smirnov statistic. A change of 10 percentage points or more in the share of missing values is an issue.
A share of repeated rows 5 percentage points or more above the seed's is an issue.

The synthetic values of x are all small, so the synthetic rows repeat each other, and every one of them is a copy of a seed row.