Search…
⌃K
Links

Visualization Utilities

Use the utilities below to visualize the comparison between real and synthetic data. You can access these from the sdmetrics.reports module.
Tip! All visualizations are interactive. If you're using an iPython notebook, you can zoom, pan, toggle legends and take screenshots.

Compare a synthetic column & real column (1D)

utils.get_column_plot(real_data, synthetic_data, sdtype)
Use this utility to visualize a real column against the same synthetic column
  • (required) real_data: A pandas.DataFrame containing the table of your real data
  • (required) synthetic_data: A pandas.DataFrame containing the synthetic data
  • (required) column_name: The name of the column you want to plot
  • (required) metadata: A dictionary of Single Table Metadata
Returns: A plotly.Figure object
from sdmetrics.reports import utils
fig = utils.get_column_plot(
real_data=real_table,
synthetic_data=synthetic_table,
column_name='high_perc',
metadata=my_table_metadata_dict
)
fig.show()
If you have Multi Table Metadata, you can access the single table using the 'tables' key. For example if your table name is 'transactions', use:
my_multi_table_metadata_dict['tables']['transactions']

Compare a pair of synthetic columns & real columns (2D)

utils.get_column_pair_plot(real_data, synthetic_data, sdtypes)
Use this utility to visualize the trends between a pair of columns for real and synthetic data
  • (required) real_data: A pandas.DataFrame containing the table of your real data
  • (required) synthetic_data: A pandas.DataFrame containing the synthetic data
  • (required) column_names: A list containing the names of the 2 columns you want to plot
  • (required) metadata: A dictionary of Single Table Metadata
Returns: A plotly.Figure object
from sdmetrics.reports import utils
fig = utils.get_column_pair_plot(
real_data=real_table,
synthetic_data=synthetic_table,
column_names=['mba_perc', 'degree_perc'],
metadata=my_table_metadata_dict
)
fig.show()
Various types of plots are possible based on the types of data you provide
If you have Multi Table Metadata, you can access a single table using the 'tables' key. For example if your table name is 'transactions', use:
my_multi_table_metadata_dict['tables']['transactions']