Synthetic Data Generator 使用教程

Synthetic Data Generator 使用教程

synthetic-data-generator Build datasets using natural language 项目地址: https://gitcode.com/gh_mirrors/syn/synthetic-data-generator

1. 项目目录结构及介绍

Synthetic Data Generator 的目录结构如下：

synthetic-data-generator/
├── assets/
├── docker/
├── examples/
├── src/
│   ├── synthetic_dataset_generator/
│   ├── tests/
├── .dockerignore
├── .env.local.template
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── app.py
├── docker-compose.yml
├── packages.txt
├── pdm.lock
├── pyproject.toml
├── requirements.txt

• assets/: 存放项目所需的静态资源。
• docker/: 包含Docker配置文件，用于容器化项目。
• examples/: 提供了一些使用示例。
• src/: 源代码目录，包含项目的核心逻辑。
  • synthetic_dataset_generator/: 数据生成器的实现代码。
  • tests/: 测试代码。
• .dockerignore: Docker构建时排除的文件列表。
• .env.local.template: 环境变量配置模板文件。
• .gitattributes: Git属性配置文件。
• .gitignore: Git忽略文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• app.py: 项目启动文件。
• docker-compose.yml: Docker Compose配置文件。
• packages.txt: 项目依赖列表。
• pdm.lock: PDM包管理器的锁定文件。
• pyproject.toml: 项目配置文件。
• requirements.txt: 项目依赖列表。

2. 项目的启动文件介绍

项目的启动文件是 app.py。这个文件负责初始化和启动 Synthetic Data Generator 应用。以下是 app.py 的基本结构：

from synthetic_dataset_generator import launch

if __name__ == "__main__":
    launch()

运行 app.py 文件将启动数据生成器，默认情况下，它会使用环境变量中配置的参数来生成数据。

3. 项目的配置文件介绍

项目的配置文件主要包括 .env.local.template 和 pyproject.toml。

• .env.local.template: 这是一个环境变量配置模板，用于定义项目运行时所需的环境变量。在使用前，你需要将这个模板文件复制为 .env.local 并填入实际的环境变量值。

• pyproject.toml: 这个文件用于定义项目的元数据和依赖。它使用 TOML 格式，包含项目的基本信息，例如项目名称、版本、作者、依赖等。

在 pyproject.toml 文件中，你可以找到如下配置：

[tool.pdm]
version = "0.15.2"
[build-system]
requires = ["pdm-pep517>=0.5.0"]
build-backend = "pdm-pep517.build backend"
[tool.pdm.project]
name = "Synthetic Data Generator"
version = "0.1.0"
description = "Build datasets using natural language"
dependencies = [
    "gradio>=2.0.0",
    # 其他依赖
]

确保在使用项目之前，你已经正确配置了所有必要的环境变量，并且安装了所有依赖项。

synthetic-data-generator Build datasets using natural language 项目地址: https://gitcode.com/gh_mirrors/syn/synthetic-data-generator