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

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

Compute this metric.

Parameters
  • real_data (Union[numpy.ndarray, pandas.DataFrame]) – The values from the real dataset.

  • synthetic_data (Union[numpy.ndarray, pandas.DataFrame]) – The values from the synthetic dataset.

  • metadata (dict) – Table metadata dict.

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

Returns

Metric output.

Return type

Union[float, tuple[float]]