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.MultiColumnPairsMetric¶

class sdv.metrics.tabular.MultiColumnPairsMetric(column_pairs_metric, **column_pairs_metric_kwargs)[source]¶

SingleTableMetric subclass that applies a ColumnPairsMetric on each possible column pair.

name¶

Name to use when reports about this metric are printed.

Type: str

goal¶

The goal of this metric.

Type: sdmetrics.goal.Goal

min_value¶

Minimum value or values that this metric can take.

Type: Union[float, tuple[float]]

max_value¶

Maximum value or values that this metric can take.

Type: Union[float, tuple[float]]

column_pairs_metric¶

ColumnPairsMetric to apply.

Type: sdmetrics.column_pairs.base.ColumnPairsMetric

field_types¶

Field types to which the SingleColumn metric will be applied.

Type: dict

__init__(column_pairs_metric, **column_pairs_metric_kwargs)[source]¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`(column_pairs_metric, …)	Initialize self.
`compute`(real_data, synthetic_data[, metadata])	Compute this metric.
`compute_breakdown`(real_data, synthetic_data)	Compute the breakdown of this metric.
`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

`column_pairs_metric`
`column_pairs_metric_kwargs`
`field_types`

sdv.metrics.tabular.SingleTableMetric.get_subclasses sdv.metrics.tabular.MultiColumnPairsMetric.get_subclasses