PyDGN 开源项目安装与使用教程

1. 项目目录结构及介绍

PyDGN 是一个基于 Python 的深度图网络框架，专注于简化深度学习在图数据上的实验过程。虽然具体的目录结构未直接提供在引用内容中，一般开源项目如PyDGN可能会遵循以下典型结构：

PyDGN/
│  
├── pydgn/                # 核心包，包含了模型、训练、评估等模块
│   ├── data/             # 数据处理相关模块
│   ├── evaluation/       # 评估方法
│   ├── experiment/       # 实验管理代码
│   ├── log/               # 日志记录工具
│   ├── model/             # 模型定义
│   └── training/          # 训练逻辑
│
├── examples/              # 示例配置文件和快速入门示例
│   ├── DATA_CONFIGS/     # 数据配置文件夹
│   └── MODEL_CONFIGS/    # 模型配置文件夹
│
├── requirements.txt      # 项目依赖清单
├── setup.py              # 安装脚本（可能含有的）
├── README.md             # 项目读我文件，包含基本说明
└── LICENSE               # 许可证文件，PyDGN 使用 GPLv3 许可

每个模块都服务于特定的目的，比如pydgn.data处理数据预处理，pydgn.model包含模型定义，而examples提供了配置实例以快速上手。

2. 项目的启动文件介绍

PyDGN 不直接通过单一的“启动文件”运行，但提供了命令行接口来便捷地执行任务。主要通过两个命令行工具进行交互：

• pydgn-dataset：用于构建数据集和数据切分。
• pydgn-train：用于训练模型，它需要配置文件来指定模型设置。

例如，初始化一个新的数据集和进行模型训练的基本流程是通过调用这两个命令，并且传入相应的配置文件：

pydgn-dataset --config-file examples/DATA_CONFIGS/config_NCI1.yml
pydgn-train --config-file examples/MODEL_CONFIGS/config_SupToyDGN.yml

3. 项目的配置文件介绍

配置文件是PyDGN的核心部分，分为数据配置(DATA_CONFIGS)和模型配置(MODEL_CONFIGS)两大类。这些YAML文件定义了如何加载数据、划分数据集以及模型的具体参数等。

数据配置文件

数据配置文件通常指定数据集的位置、切分策略（训练、验证、测试）和其他数据预处理选项。例如，config_NCI1.yml可能包括数据集路径、标签信息和是否需要进行随机切分等内容。

# 假设的例子
dataset_name: NCI1
split_strategy: random_split
test_size: 0.2

模型配置文件

模型配置文件详细描述了要训练的深度图网络的架构、优化器的选择、学习率等。比如，在config_SupToyDGN.yml中，用户可以定义模型类型（如GCN、GAT）、层数、每层的神经元数量、损失函数、批次大小等关键参数。

model_type: SupToyDGN
hidden_channels: 64
num_layers: 2
learning_rate: 0.01

确保在实际操作前，依据项目最新的文档调整或创建这些配置文件，以符合你的具体需求和环境设置。此外，考虑到项目的持续更新，具体的文件结构和命令可能会有所变化，因此建议参照项目的GitHub主页或最新文档获取最准确的信息。