Skip to content

Update DiagnosticReport to include ConstraintValidity property #901

Description

@sarahmish

Problem Description

Once we have created the ConstraintAdherence (#899) metric and ConstraintValidity (#900) property, we'd like to update the DiagnosticReport to include a fourth property "Constraint Validity".

>>> from sdmetrics.reports import DiagnosticReport
>>> report = DiagnosticReport()
>>> report.generate(real_data, synthetic_data, metadata, constraints)

Expected behavior

  • Add property ConstraintValidity for diagnostic reports.
  • Update DiagnosticReport to take in an optional input constraints.

Score Calculation

The Constraint Validity property score gets averaged into the overall DiagnosticReport score.

When running this report, the Constraint Validity property should be run last.

  • If there are constraints, then we should show a progress bar that increments 1 time for each constraint.
  • If there are no constraints, then the property score is NaN
>>> report.generate(real_data, synthetic_data, metadata, constraints)

Generating report ...
(1/4) Evaluating Data Validity: |██████████| 15/15
Data Validity Score: 100.0%

(2/4) Evaluating Data Structure: |██████████| 2/2
Data Structure Score: 100.0%

(3/4) Evaluating Relationship Validity: |██████████| 1/1
Relationship Validity Score: 100.0%

(4/4) Evaluating Constraint Validity: |██████████| 10/10
Constraint Validity Score: 100.0%

Overall Score (Average): 100.0%

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions