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.SingleTableMetric

class sdv.metrics.tabular.SingleTableMetric[source]

Base class for metrics that apply to single tables.

Input to these family of metrics are two pandas.DataFrame instances and a dict representations of the corresponding Table metadata.

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]]

__init__()

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

Methods

__init__()

Initialize self.

compute(real_data, synthetic_data[, metadata])

Compute this metric.

compute_breakdown(real_data, synthetic_data)

Compute this metric breakdown.

get_subclasses([include_parents])

Recursively find subclasses of this metric.

normalize(raw_score)

Compute the normalized value of the metric.

Attributes

goal

max_value

min_value

name