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.relational.MultiSingleTableMetric¶

class sdv.metrics.relational.MultiSingleTableMetric(single_table_metric)[source]¶

MultiTableMetric subclass that applies a SingleTableMetric on each table.

This class can either be used by creating a subclass that inherits from it and sets the SingleTable Metric as the single_table_metric attribute, or by creating an instance of this class passing the underlying SingleTable metric as an argument.

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

single_table_metric¶

SingleTableMetric to apply.

Type: sdmetrics.single_table.base.SingleTableMetric

__init__(single_table_metric)[source]¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`(single_table_metric)	Initialize self.
`compute`(real_data, synthetic_data[, metadata])	Compute this metric.
`compute_breakdown`(real_data, synthetic_data)	Compute this metric broken down by tables and columns.
`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

single_table_metric

sdv.metrics.relational.MultiTableMetric.get_subclasses sdv.metrics.relational.MultiSingleTableMetric.get_subclasses