Danger

You are looking at the documentation for an older version of the SDV! We are no longer supporting or maintaining this version of the software

Click here to go to the new docs pages.

sdv.metrics.tabular.CSTest

class sdv.metrics.tabular.CSTest(single_column_metric=None, **single_column_metric_kwargs)[source]

MultiSingleColumnMetric based on SingleColumn CSTest.

This function applies the single column CSTest metric to all the discrete columns found in the table and then returns the average of all the scores obtained.

__init__(single_column_metric=None, **single_column_metric_kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([single_column_metric])

Initialize self.

compute(real_data, synthetic_data[, metadata])

Compute this metric.

compute_breakdown(real_data, synthetic_data)

Compute this metric broken down by column.

get_subclasses([include_parents])

Recursively find subclasses of this metric.

normalize(raw_score)

Return the raw_score as is, since it is already normalized.

Attributes

field_types

goal

max_value

min_value

name

single_column_metric_kwargs