qolmat.benchmark.metrics.total_variance_distance

qolmat.benchmark.metrics.total_variance_distance(df1: DataFrame, df2: DataFrame, df_mask: DataFrame) Series[source]

Compute the total variance distance for categorical features.

It is based on TVComplement in https://github.com/sdv-dev/SDMetrics

Parameters
df1pd.DataFrame

true dataframe

df2pd.DataFrame

predicted dataframe

df_maskpd.DataFrame

Elements of the dataframes to compute on

Returns
pd.Series

Total variance distance