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.KSComplement.compute

classmethod KSComplement.compute(real_data, synthetic_data, metadata=None, **kwargs)

Compute this metric.

This is done by computing the underlying SingleColumn metric to all the columns that are compatible with it.

The output is the average of the scores obtained.

Parameters
  • real_data (pandas.DataFrame) – The values from the real dataset.

  • synthetic_data (pandas.DataFrame) – The values from the synthetic dataset.

  • metadata (dict) – Table metadata dict.

  • **kwargs – Any additional keyword arguments will be passed down to the single column metric

Returns

Metric output.

Return type

Union[float, tuple[float]]