EDGS 项目安装与使用教程

1. 项目的目录结构及介绍

EDGS（Efficient Deep Graph Setter）项目的目录结构如下：

EDGS/
├── data/                 # 存放数据集
├── docs/                 # 项目文档
├── examples/             # 示例代码
├── experiments/          # 实验结果和配置
├── models/               # 模型定义和训练代码
├── scripts/              # 脚本文件，如数据预处理等
├── tests/                # 测试代码
├── tools/                # 工具函数和库
├── utils/                # 通用工具和配置
├── requirements.txt      # 项目依赖
├── setup.py              # 项目设置
└── main.py               # 项目主程序

• data/：存放项目所需的数据集。
• docs/：包含项目的文档和教程。
• examples/：提供了一些如何使用该项目的基础示例代码。
• experiments/：保存实验结果和配置文件，方便复现实验。
• models/：包含了项目中的模型定义和训练代码。
• scripts/：包含一些脚本文件，如数据预处理、模型训练等。
• tests/：包含项目的单元测试代码。
• tools/：包含项目需要的工具函数和库。
• utils/：包含了通用的工具和配置文件。
• requirements.txt：列出了项目依赖的第三方库。
• setup.py：项目设置文件，用于安装项目依赖。
• main.py：项目的主程序入口。

2. 项目的启动文件介绍

项目的启动文件是 main.py。这个文件负责初始化项目，加载配置文件，处理输入数据，并调用相应的模型进行训练或推理。

import sys
import os
from utils import config
from models import Model

def main():
    # 加载配置文件
    cfg = config.load_config("config.yaml")
    
    # 初始化模型
    model = Model(cfg)
    
    # 训练或推理
    if cfg["mode"] == "train":
        model.train()
    elif cfg["mode"] == "infer":
        model.infer()

if __name__ == "__main__":
    main()

在 main.py 中，首先加载配置文件 config.yaml，然后根据配置中的模式（训练或推理）调用相应的方法。

3. 项目的配置文件介绍

项目的配置文件通常为 config.yaml，它包含了项目运行时所需的各种配置参数，例如数据路径、模型参数、训练设置等。

以下是一个配置文件的示例：

mode: train
data_path: ./data/
model:
  name: EDGS
  params:
    hidden_units: 128
    learning_rate: 0.001
train:
  epochs: 10
  batch_size: 32

在这个配置文件中：

• mode 定义了程序运行的模式，可以是 train（训练）或 infer（推理）。
• data_path 指定了数据集的存储路径。
• model 包含了模型名称和参数，如隐藏单元数量和学习率。
• train 包含了训练的配置，如训练的轮数和批次大小。

通过配置文件，用户可以轻松调整项目的参数而不需要修改代码，从而提高项目的灵活性和可维护性。