This metric measures the similarity between a real column and a synthetic column by comparing a summary statistic. Supported summary statistics are: mean, median and standard deviation.
- Numerical : This metric is meant for continuous, numerical data
- Datetime : This metric converts datetime values into numerical values
This metric ignores missing values.
(best) 1.0: The statistic for the real data is exactly the same at the synthetic data
(worst) 0.0: The statistic for the real data is extremely different from the synthetic data
This test computes the given statistical function, f, for the real data and synthetic columns, r and s. Then, the test normalizes the score by scaling and taking its complement. This create a score that falls within the [0, 1] range*, where a high value means high similarity.
The supported statistical functions (f) are: the (arithmetic) mean, median and standard deviation.
*In rare cases, where the synthetic data statistic is very different from the real data, the computed score may be negative. In such cases we clip the score to 0, the worst possible score.
Access this metric from the
single_columnmodule and use the
from sdmetrics.single_column import StatisticSimilarity
real_data: A pandas.Series object with the column of real data
synthetic_data: A pandas.Series object with the column of synthetic data
statistic: A string describing the name of the statistical function
'mean': The arithmetic mean
'median': The median value
'std': The standard deviation
The mean and median summarize the values differently, especially when your data has a skew .
- The mean takes all values into account. It may be significantly affected by just a few large or small values. You can use the mean for a fast computation if you know there is no skew in your data or if you are ok with outliers affecting the score.
- The median finds a middle value where 50% of the data is larger and 50% is smaller. The median is resilient to outliers in either direction. This may be desirable if you have skewed data, as the score is more representative of the typical values. Note that this computation takes longer.
A high score is indicative that the summarized statistic are close to each other. However, even if all statistics are exactly 1.0, you may still find some differences in the shapes of the synthetic vs. real data.