diff --git a/apt/risk/data_assessment/dataset_attack_result.py b/apt/risk/data_assessment/dataset_attack_result.py index 0ed0bd4..afd4b36 100644 --- a/apt/risk/data_assessment/dataset_attack_result.py +++ b/apt/risk/data_assessment/dataset_attack_result.py @@ -8,11 +8,21 @@ DEFAULT_DATASET_NAME = "dataset" @dataclass class DatasetAttackResult: + """ + Basic class for storing privacy risk assessment results. + """ pass @dataclass class DatasetAttackScore: + """ + Basic class for storing privacy risk assessment scores. + + :param dataset_name: The name of the dataset that was assessed. + :param risk_score: The privacy risk score. + :param result: An optional list of more detailed results. + """ dataset_name: str risk_score: float result: Optional[DatasetAttackResult] @@ -20,5 +30,11 @@ class DatasetAttackScore: @dataclass class DatasetAttackResultMembership(DatasetAttackResult): + """ + Class for storing membership attack results. + + :param member_probabilities: The attack probabilities for member samples. + :param non_member_probabilities: The attack probabilities for non-member samples. + """ member_probabilities: np.ndarray non_member_probabilities: np.ndarray