From f7298bec0e52725fdc45b3dc2bfea1c76970424e Mon Sep 17 00:00:00 2001 From: R-Palazzo Date: Tue, 31 Oct 2023 09:14:19 -0600 Subject: [PATCH] docstring --- .../reports/multi_table/_properties/relationship_validity.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdmetrics/reports/multi_table/_properties/relationship_validity.py b/sdmetrics/reports/multi_table/_properties/relationship_validity.py index a49588bb..65ff198a 100644 --- a/sdmetrics/reports/multi_table/_properties/relationship_validity.py +++ b/sdmetrics/reports/multi_table/_properties/relationship_validity.py @@ -8,7 +8,7 @@ class RelationshipValidity(BaseMultiTableProperty): - """``Relationship Validity`` class. + """``Relationship Validity`` property. This property measures the validity of the relationship from the primary key and the foreign key perspective. @@ -18,7 +18,7 @@ class RelationshipValidity(BaseMultiTableProperty): _num_iteration_case = 'relationship' def _generate_details(self, real_data, synthetic_data, metadata, progress_bar=None): - """Get the average score of relationship validity in the given tables. + """Generate the _details dataframe for the relationship validity property. Args: real_data (dict[str, pandas.DataFrame]):