Update compute_breakdown returns docstring

sdv-dev · Dec 4, 2024 · 6d21816 · 6d21816
1 parent bbe6fe2
commit 6d21816
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/sdmetrics/single_table/privacy/disclosure_protection.py b/sdmetrics/single_table/privacy/disclosure_protection.py
@@ -1,4 +1,4 @@
-"""DisclosureProtection metrics."""
+"""Disclosure protection metrics."""
 
 import numpy as np
 import pandas as pd
@@ -135,7 +135,10 @@ def compute_breakdown(
 
         Returns:
             dict
-                Mapping of the metric output. Must include the key 'score'.
+                Mapping of the metric output with the keys:
+                    - 'score': The overall score for the metric.
+                    - 'cap_protection': The protection score from the selected computation method.
+                    - 'baseline_protection': The baseline protection for the columns.
         """
         cls._validate_inputs(
             real_data,