Synthesized SDK + Jupyter Notebook服务器 + 可选API服务器

Synthesized的Docker镜像包含SDK与Jupyter Notebook服务器，提供便捷平台用于开始合成数据实验。有关安装和使用Synthesized SDK的更多详情，请参见：[***]

快速开始 - Jupyter Notebook服务器

要安装并运行容器，需在您的机器上安装Docker。您可在此处找到Docker安装说明：[***]

docker run -p 8888:8888 synthesizedio/sdk-jupyter-server

这将在8888端口启动Jupyter Notebook服务器。之后您可访问http://localhost:8888开始使用SDK。镜像中包含基础示例笔记本以帮助您快速上手，SDK完整文档可在此处查看：https://docs.synthesized.io/。

| 警告：服务器默认未设置令牌/密码。 对于任何公开暴露的端点，应添加令牌/密码及其他安全措施。

可通过运行Docker镜像时使用-e标志指定JUPYTER_NOTEBOOK_TOKEN环境变量，为Jupyter Notebook服务器添加令牌/密码，如下所示：

docker run -p 8888:8888 -e JUPYTER_NOTEBOOK_TOKEN=PutYourTokenHere synthesizedio/sdk-jupyter-server

注意： 您需要将PutYourTokenHere替换为您想要设置的服务器令牌/密码。

您可通过运行镜像时使用-v标志将本地文件夹挂载到Docker容器，以加载和使用您自己的Jupyter笔记本（及其他文件，如数据），如下所示：

docker run -p 8888:8888 -v /path/to/your/notebooks:/synthesized/notebooks synthesizedio/sdk-jupyter-server

注意： 您需要将/path/to/your/notebooks替换为您机器上的目录路径。

许可证密钥

运行Synthesized需拥有有效的许可证密钥。可通过以下方式设置密钥：

在笔记本开始时运行以下命令设置环境变量：

import os
os.environ['SYNTHESIZED_KEY'] = 'LICENCE_KEY_HERE'

您也可在运行Docker容器时通过指定SYNTHESIZED_KEY环境变量设置密钥，命令如下：

docker run -p 8888:8888 -e SYNTHESIZED_KEY=LICENCE_KEY_HERE synthesizedio/sdk-jupyter-server

注意： 您需要将LICENCE_KEY_HERE替换为您自己的许可证密钥。

可选 - API服务器

除Jupyter Notebook服务器外，还可额外启动并暴露SDK API服务器（用于暴露配置生成和数据合成端点）。 要指定启动API服务器，需将环境变量ENABLE_API_SERVER设置为true。此外，需如上设置SYNTHESIZED_KEY环境变量，并暴露8890端口。完整命令如下：

docker run -p 8890:8890 -p 8888:8888 -e SYNTHESIZED_KEY=LICENCE_KEY_HERE -e ENABLE_API_SERVER=true synthesizedio/sdk-jupyter-server

这将启动API服务器并在8890端口暴露。

暴露的端点

暴露两个端点：

1. POST /dataset/meta

此端点用于为输入数据集生成并返回默认配置。

使用时，向localhost:8890/dataset/meta发送POST请求，在请求体中指定键"path"，其值为CSV文件路径。该路径可以是本地文件（需已挂载到Docker容器）或CSV文件的URL（如公开托管的原始CSV）。

2. POST /dataset/synthesize

此端点返回合成数据集（根据指定配置合成，若未提供特定配置则使用默认配置）及所用配置。

使用时，向localhost:8890/dataset/synthesize发送POST请求，在请求体中指定键"path"，其值为CSV文件路径。该路径可以是本地文件（需已挂载到Docker容器）或CSV文件的URL（如公开托管的原始CSV）。可提供可选参数"config"，其值必须是指定数据集的完整配置文件（JSON格式）。若未提供配置，将自动生成并使用默认配置。

| 注意：此端点将训练完整的合成器。 此过程可能需要数分钟（至少5分钟，通常10分钟），因此端点将持续等待直至训练和合成完成。