diff --git a/sdmetrics/column_pairs/statistical/cardinality_boundary_adherence.py b/sdmetrics/column_pairs/statistical/cardinality_boundary_adherence.py index 4129a760..15f55b98 100644 --- a/sdmetrics/column_pairs/statistical/cardinality_boundary_adherence.py +++ b/sdmetrics/column_pairs/statistical/cardinality_boundary_adherence.py @@ -1,4 +1,4 @@ -"""ColumnPair metrics based on Kullback–Leibler Divergence.""" +"""ColumnPair metric for Cardinality Boundary Adherence.""" import pandas as pd @@ -41,7 +41,7 @@ def compute_breakdown(real_data, synthetic_data): foreign keys as the second element. Returns: - Union[float, tuple[float]]: + dict Metric output. """ real_cardinality = pd.DataFrame(index=real_data[0].copy()) @@ -74,7 +74,7 @@ def compute(cls, real_data, synthetic_data): foreign keys as the second element. Returns: - Union[float, tuple[float]]: + float: Metric output. """ return cls.compute_breakdown(real_data, synthetic_data)['score']