From 6d21816ac6d4df2517b990db3ddd967461f5d06c Mon Sep 17 00:00:00 2001 From: Frances Hartwell Date: Mon, 2 Dec 2024 13:48:08 -0500 Subject: [PATCH] Update compute_breakdown returns docstring --- sdmetrics/single_table/privacy/disclosure_protection.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/sdmetrics/single_table/privacy/disclosure_protection.py b/sdmetrics/single_table/privacy/disclosure_protection.py index 05807260..0926b146 100644 --- 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,