<div align="center"> <br/> <p align="center"> <i>此仓库是 <a href="https://sdv.dev">The Synthetic Data Vault Project</a> 的一部分，该项目由 <a href="https://datacebo.com">DataCebo</a> 提供支持。</i> </p>

概述

Synthetic Data Vault (SDV) 是一个Python库，旨在成为您的合成表格数据创建的一站式解决方案。SDV使用多种机器学习算法来学习真实数据中的模式，并在合成数据中模仿它们。

特性

:brain: 使用机器学习生成合成数据。 SDV提供了多种模型，从经典的统计方法（GaussianCopula）到深度学习方法（CTGAN）均可应用。可以为单个表、多张互相关联的表或序列表生成数据。

:bar_chart: 评估和可视化数据。 根据各种度量标准，将合成数据与实际数据进行比较。诊断问题并生成质量报告以获得更多见解。

:arrows_counterclockwise: 预处理、匿名化和定义约束。 控制数据处理以提高合成数据的质量，从不同类型的匿名化方法中选择，并以逻辑约束的形式定义业务规则。

重要链接
教程	通过SDV获得一些动手体验。启动教程笔记本并亲自运行代码。
:book: [文档]	通过用户指南和API参考来学习如何使用SDV库。
:orange_book: [博客]	获取更多关于使用SDV、部署模型以及我们的合成数据社区的见解。
社区	加入我们的Slack工作区获取公告和讨论。
:computer: [网站]	查看SDV网站以获取有关项目的更多信息。

安装

SDV是根据商业源代码许可证公开提供的。使用pip或conda安装SDV。我们建议使用虚拟环境以避免与设备上其他软件发生冲突。

pip install sdv

conda install -c pytorch -c conda-forge sdv

入门

加载一个演示数据集以开始。此数据集是描述虚构酒店客人住宿的单张表。

from sdv.datasets.demo import download_demo

real_data, metadata = download_demo(
    modality='single_table',
    dataset_name='fake_hotel_guests')

单表元数据示例

演示还包括元数据，它是对数据集的描述，包括每列中的数据类型和主键（guest_email）。

合成数据

接下来，我们可以创建一个SDV合成器，这是一个可以用来创建合成数据的对象。它从真实数据中学习模式，并复制这些模式生成合成数据。让我们使用GaussianCopulaSynthesizer。

from sdv.single_table import GaussianCopulaSynthesizer

synthesizer = GaussianCopulaSynthesizer(metadata)
synthesizer.fit(data=real_data)

现在合成器已准备好生成合成数据！

synthetic_data = synthesizer.sample(num_rows=500)

合成数据将具有以下特性：

敏感列完全匿名化。 邮件、账单地址和信用卡号列包含新数据，因此您不会暴露真实值。
其他列遵循统计模式。 例如，房间类型的比例、入住日期的分布和房价与房间类型之间的相关性得到了保留。
键和其他关系保持完整。 主键（客人邮箱）对每行都是唯一的。如果您有多个表，主键和外键之间的连接是有意义的。

评估合成数据

SDV库允许您通过将合成数据与实际数据进行比较来评估合成数据。首先生成一个质量报告。

from sdv.evaluation.single_table import evaluate_quality

quality_report = evaluate_quality(
    real_data,
    synthetic_data,
    metadata)

生成报告中...

(1/2) 评估列形状: |████████████████| 9/9 [00:00<00:00, 1133.09it/s]|
列形状得分: 89.11%

(2/2) 评估列对趋势: |██████████████████████████████████████████| 36/36 [00:00<00:00, 502.88it/s]|
列对趋势得分: 88.3%

总体得分（平均值）：88.7%

该对象计算了一个0到100%（100为最佳）的总体质量得分，并给出详细的分解。为了获得更多见解，您还可以将合成数据与真实数据进行可视化比较。

from sdv.evaluation.single_table import get_column_plot

fig = get_column_plot(
    real_data=real_data,
    synthetic_data=synthetic_data,
    column_name='amenities_fee',
    metadata=metadata
)
    
fig.show()

真实数据与合成数据

接下来做什么？

使用SDV库，您可以合成单表、多表和序列数据。您还可以定制完整的合成数据工作流，包括预处理、匿名化和添加约束。

要了解更多信息，请访问SDV演示页面。

致谢

感谢我们多年来建设和维护SDV生态系统的团队！

查看贡献者

引用

如果您在研究中使用了SDV，请引用以下论文：

Neha Patki, Roy Wedge, Kalyan Veeramachaneni. The Synthetic Data Vault. IEEE DSAA 2016.

@inproceedings{
    SDV,
    title={The Synthetic data vault},
    author={Patki, Neha and Wedge, Roy and Veeramachaneni, Kalyan},
    booktitle={IEEE International Conference on Data Science and Advanced Analytics (DSAA)},
    year={2016},
    pages={399-410},
    doi={10.1109/DSAA.2016.49},
    month={Oct}
}

The Synthetic Data Vault Project 于2016年在MIT的数据到AI实验室首次创建。经过4年的研究并在企业中获得了足够的发展，于2020年成立了DataCebo，旨在推动这一项目的发展。今天，DataCebo自豪地成为SDV的开发者，SDV是合成数据生成和评估的最大生态系统。它是多个支持合成数据的库的家园，包括：