Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create multi-table QualityReport #186

Closed
katxiao opened this issue Aug 12, 2022 · 0 comments · Fixed by #204
Closed

Create multi-table QualityReport #186

katxiao opened this issue Aug 12, 2022 · 0 comments · Fixed by #204
Assignees
Labels
feature request Request for a new feature
Milestone

Comments

@katxiao
Copy link
Contributor

katxiao commented Aug 12, 2022

Problem Description

Create the multi table QualityReport class. Implement the generate method and functionality.

The generate method should take in the real and synthetic dataframes for computing the following:

Compute & saves breakdowns for all of the endorsed metrics —

  • KSComplement
  • TVComplement
  • CorrelationSimilarity with both 'Pearson' and 'Spearman'
  • ContingencySimilarity
  • CardinalityShapeSimilarity

Use tqdm to communicate progress. After it's finished, it should print out the general score and a rough breakdown.

Expected behavior

>>> from sdmetrics.reports.multi_table import QualityReport
>>> report = QualityReport()
>>> report.generate(real_data, synthetic_data, metadata)
Creating report:  96%|█████████▌| 192/200 [01:21<00:03,  2.37it/s]

Overall Quality Score: 78%

Properties:
Column Shapes: 91%
Column Pair Trends: 74%
Table Relationships: 69% # available for multi table only

Additional context

@katxiao katxiao added the feature request Request for a new feature label Aug 12, 2022
@katxiao katxiao self-assigned this Aug 30, 2022
@katxiao katxiao added this to the 0.7.0 milestone Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant