SmartNoise SDK 使用教程

1. 项目目录结构及介绍

SmartNoise SDK 是一个用于处理表格和关系数据的不同隐私工具和服务集合。其目录结构如下：

smartnoise-sdk/
├── datasets/
├── docs/
├── dpsdgym/
├── eval/
├── images/
├── sql/
├── synth/
├── .gitattributes
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── SECURITY.md
├── contributing.rst
└── tox.ini

目录介绍

• datasets/: 包含示例数据集文件。
• docs/: 包含项目的文档文件。
• dpsdgym/: 包含用于测试和评估的工具。
• eval/: 包含评估脚本和工具。
• images/: 包含项目相关的图片文件。
• sql/: 包含用于执行不同隐私 SQL 查询的工具和脚本。
• synth/: 包含用于生成不同隐私合成数据的工具和脚本。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• Makefile: 用于构建和管理的 Makefile。
• README.md: 项目的主 README 文件。
• SECURITY.md: 项目的安全策略文件。
• contributing.rst: 贡献指南文件。
• tox.ini: 用于测试和构建的配置文件。

2. 项目启动文件介绍

SmartNoise SDK 的启动文件主要集中在 sql/ 和 synth/ 目录中。以下是一些关键的启动文件：

SQL 启动文件

• sql/README.md: 提供了如何使用 smartnoise-sql 包的详细说明和示例代码。
• sql/examples/: 包含多个 SQL 查询示例，展示了如何使用不同隐私保护机制执行 SQL 查询。

合成数据启动文件

• synth/README.md: 提供了如何使用 smartnoise-synth 包的详细说明和示例代码。
• synth/examples/: 包含多个合成数据生成示例，展示了如何生成不同隐私保护的合成数据。

3. 项目的配置文件介绍

SmartNoise SDK 的配置文件主要包括以下几个：

• .gitattributes: 用于配置 Git 的属性，例如文件的换行符处理等。
• .gitignore: 用于指定 Git 忽略的文件和目录。
• Makefile: 用于自动化构建、测试和部署的配置文件。
• tox.ini: 用于配置测试环境的文件，支持多版本 Python 的测试。

配置文件示例

.gitattributes

* text=auto
*.md text eol=lf

.gitignore

__pycache__/
*.pyc
*.pyo
*.pyd
*.db
*.sqlite3

Makefile

install:
    pip install -r requirements.txt

test:
    tox

build:
    python setup.py sdist bdist_wheel

tox.ini

[tox]
envlist = py36,py37,py38

[testenv]
deps =
    pytest
commands =
    pytest

通过以上配置文件，可以方便地进行项目的构建、测试和部署。