Multi Table API
Last updated
Last updated
The Multi 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 multiple, connected tables of data.
Create your report object by importing it from the multi table reports module.
Generate your report by passing in the data and metadata.
(required) real_data
: A dictionary mapping the name of each table to a pandas.DataFrame containing the real data for that table
(required) synthetic_data
: A dictionary mapping the name of each table to a pandas.DataFrame containing the synthetic data for that table
(required) metadata
: A dictionary describing the format, types of data and relationship between the tables. See 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.
You'll see a progress bar as the report is generated. Once completed, the diagnostic results are printed out.
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.
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
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'
, 'Data Structure'
or 'Relationship Validity'
.
table_name
: A string with the name of the table. If provided, you'll receive filtered results for the table.
Returns: A pandas.DataFrame object that returns more details about the property for the given table
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.
You can visualize the properties and use the SDMetrics utilities to visualize the raw data too.
Use this method to visualize the details about a property.
(required) property_name
: A string with the name of the property. Currently, 'Data Validity'
or 'Relationship Validity'
are supported.
(required) table_name
: A string with the name of the table
For example, the 'Data Validity'
property visualizes the score for every column as well as the metric used to compute it.
You can save your report if you want to share or access it in the future.
Save the Python report object
(required) filepath
: The name of file to save the object. This must end with .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.
Load the report from the file
(required) filepath
: The name of the file where the report is stored
Returns: A DiagnosticReport
object.
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.
Returns: A object
Other visualizations are available! Use the 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.
This report returns all visualizations as object, which are integrated with most iPython notebooks (eg. Colab, Jupyter).
It's also possible to programmatically save a static image export. See the for more details.