开源项目 SyntheticData 使用教程
1. 项目的目录结构及介绍
SyntheticData/
├── data/
│ ├── raw/
│ └── processed/
├── src/
│ ├── generators/
│ ├── utils/
│ └── main.py
├── config/
│ ├── default.yaml
│ └── custom.yaml
├── README.md
├── LICENSE
└── requirements.txt
data/
: 存储原始数据和处理后的数据。raw/
: 存放原始数据文件。processed/
: 存放处理后的数据文件。
src/
: 项目的主要代码文件夹。generators/
: 包含数据生成的相关模块。utils/
: 包含一些辅助工具函数。main.py
: 项目的启动文件。
config/
: 配置文件夹。default.yaml
: 默认配置文件。custom.yaml
: 自定义配置文件。
README.md
: 项目说明文档。LICENSE
: 项目许可证。requirements.txt
: 项目依赖文件。
2. 项目的启动文件介绍
src/main.py
是项目的启动文件,负责初始化配置、加载数据和启动数据生成过程。以下是 main.py
的主要功能:
import config.default as config
from src.generators import DataGenerator
def main():
# 加载配置
cfg = config.load_config()
# 初始化数据生成器
generator = DataGenerator(cfg)
# 生成数据
generator.generate()
if __name__ == "__main__":
main()
config.load_config()
: 加载配置文件。DataGenerator(cfg)
: 根据配置初始化数据生成器。generator.generate()
: 执行数据生成过程。
3. 项目的配置文件介绍
config/default.yaml
和 config/custom.yaml
是项目的配置文件。default.yaml
包含默认配置,而 custom.yaml
允许用户自定义配置。
以下是 default.yaml
的一个示例:
data_path: "data/raw"
output_path: "data/processed"
num_samples: 1000
image_size: [256, 256]
data_path
: 原始数据路径。output_path
: 处理后的数据输出路径。num_samples
: 生成的样本数量。image_size
: 生成的图像尺寸。
用户可以在 custom.yaml
中覆盖这些配置,以满足特定需求。