Single Table API

The Single Table Diagnostic Report runs some basic checks on your synthetic data to give a general sense of the strengths and weakness of your synthetic data model.

Use this report when you have a single table of data.

Usage

Generating the report

DiagnosticReport()

Create your report object by importing it from the single table reports module.

from sdmetrics.reports.single_table import DiagnosticReport

report = DiagnosticReport()

generate(real_data, synthetic_data, metadata)

Generate your report by passing in the data and metadata.

  • (required) real_data: A pandas.DataFrame containing the real data

  • (required) synthetic_data: A pandas.DataFrame containing the synthetic data

  • (required) metadata: A dictionary describing the format and types of data. See Single Table Metadata for more details.

  • verbose: A boolean describing whether or not to print the report progress and results. Defaults to True. Set this to False to run the report silently.

report.generate(real_data, synthetic_data, metadata)

You'll see a progress bar as the report is generated. Once completed, the diagnostic results are printed out.

Generating report ...
(1/2) Evaluating Data Validity: : 100%|██████████| 17/17 [00:00<00:00, 374.65it/s]
(2/2) Evaluating Data Structure: : 100%|██████████| 1/1 [00:00<00:00, 104.39it/s]

Overall Score: 100.0%

Properties:
- Data Validity: 100.0%
- Data Structure: 100.0%

Getting & explaining the results

get_score()

Use this method at any point to retrieve the overall score.

Returns: A floating point value between 0 and 1 that summarizes the quality of your synthetic data.

report.get_score()
1.0

💯 The score should be 100% or very close to it. The diagnostic report checks for basic data validity and data structure issues. If you want to create synthetic data that looks and feels similar to the real data, you should expect to score to be perfect. If you are using any of the default SDV synthesizers, the score should always be 1.0.

get_properties()

Use this method at any point to retrieve each property that the report evaluated

Returns: A dictionary that lists each property name and its associated score

report.get_properties()
{
  'Data Validity': 1.0,
  'Data Structure': 1.0,
}

get_details(property_name)

Use this method to get more details about a particular property.

  • (required) property_name: A string with the name of the property. One of: 'Data Validity' or 'Data Structure'.

Returns: A pandas.DataFrame object that returns more details about the property

For example, the details for 'Data Validity' shows the name of each individual column, the metric that was used to compute it and the overall score for that column.

report.get_details(property_name='Data Validity')
Column        Metric                 Score
user_id       KeyUniqueness          1.0   
age           BoundaryAdherence      1.0     
height        BoundaryAhderence      1.0            
card_type     CategoryAdherence      1.0
...

Visualizing the report

You can visualize the properties and use the SDMetrics utilities to visualize the raw data too.

get_visualization(property_name)

Use this method to visualize the details about a property.

  • (required) property_name: A string with the name of the property. Currently, only 'Data Validity' is supported.

Returns: A plotly.Figure object

For example, the 'Data Validity' property visualizes the score for every column as well as the metric used to compute it.

fig = report.get_visualization(property_name='Data Validity')
fig.show()

Other visualizations are available! Use the SDMetrics Visualization Utilities to get more insights into your data. Tip! All visualizations returned in this report are interactive. If you're using an iPython notebook, you can zoom, pan, toggle legends and take screenshots.

Saving & loading the report

You can save your report if you want to share or access it in the future.

save(filepath)

Save the Python report object

  • (required) filepath: The name of file to save the object. This must end with .pkl

report.save(filepath='results/diagnostic_report.pkl')

The report does not save the full real and synthetic datasets, but it does save the metadata along with the score for each property, breakdown and metric.

The score information may still leak sensitive details about your real data. Use caution when deciding where to store the report and who to share it with.

DiagnosticReport.load(filepath)

Load the report from the file

  • (required) filepath: The name of the file where the report is stored

Returns: A DiagnosticReport object.

from sdmetrics.reports.single_table import DiagnosticReport

report = DiagnosticReport.load('results/diagnostic_report.pkl')

FAQs

What is the best way to see the visualizations? Can I save them?

This report returns all visualizations as plotly.Figure object, which are integrated with most iPython notebooks (eg. Colab, Jupyter).

Tip! You can interact with the visualizations when you're viewing them in a notebook. You can zoom, pan and take screenshots.

It's also possible to programmatically save a static image export. See the Plotly Guide for more details.

Last updated