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.
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
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.
pandas.DataFrame
dict
Table
name
Name to use when reports about this metric are printed.
str
goal
The goal of this metric.
sdmetrics.goal.Goal
min_value
Minimum value or values that this metric can take.
Union[float, tuple[float]]
max_value
Maximum value or values that this metric can take.
__init__
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__()
Initialize self.
compute(real_data, synthetic_data[, metadata])
compute
Compute this metric.
compute_breakdown(real_data, synthetic_data)
compute_breakdown
Compute this metric breakdown.
get_subclasses([include_parents])
get_subclasses
Recursively find subclasses of this metric.
normalize(raw_score)
normalize
Compute the normalized value of the metric.
Attributes