synthval.metrics.SimilarityMetric#

class synthval.metrics.SimilarityMetric#

Bases: abc.ABC

Abstract base class representing a generic similarity metric between two sets of samples originating from two multivariate distributions. Child classes must implement the concrete calculate method for computing the specific metric.

abstractmethod calculate(real_dist_df, synth_dist_df)#

Abstract method to compute a metric of similarity between two set of samples originating from two multivariate distribution real_dist and synth_dist.

Parameters:

  • real_dist_df (pandas.DataFrame) – Set of samples representing distribution real_dist.

  • synth_dist_df (pandas.DataFrame) – Set of samples representing distribution synth_dist.

Returns:

A numpy array containing the value (or values) of the metric.

Return type:

numpy.ndarray