docstring

sdv-dev · Oct 23, 2023 · ec21e2c · ec21e2c
1 parent e72e903
commit ec21e2c
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/sdmetrics/single_column/statistical/category_adherence.py b/sdmetrics/single_column/statistical/category_adherence.py
@@ -9,7 +9,7 @@
 class CategoryAdherence(SingleColumnMetric):
     """Category adherence metric.
 
-    Compute the fraction of synthetic values that match at least 1 value in the real data.
+    The proportion of synthetic data points that match an existing category from the real data.
 
     Attributes:
         name (str):
@@ -39,7 +39,7 @@ def compute_breakdown(cls, real_data, synthetic_data):
 
         Returns:
             dict:
-                The score breakdown of the key uniqueness metric.
+                The score breakdown of the category adherence metric.
         """
         real_data = real_data.fillna(np.nan)
         synthetic_data = synthetic_data.fillna(np.nan)
@@ -59,7 +59,7 @@ def compute(cls, real_data, synthetic_data):
 
         Returns:
             float:
-                The key uniqueness of the two columns.
+                The category adherence metric score.
         """
         return cls.compute_breakdown(real_data, synthetic_data)['score']