开源项目 DIG 使用教程

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

DIG/
├── configs/
├── data/
├── dig/
│   ├── datasets/
│   ├── explain/
│   ├── experiments/
│   ├── models/
│   ├── utils/
│   └── __init__.py
├── docs/
├── examples/
├── scripts/
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

• configs/: 包含项目的配置文件。
• data/: 用于存放数据集的目录。
• dig/: 核心代码目录，包含数据集处理、模型定义、实验等子模块。
  • datasets/: 数据集处理相关代码。
  • explain/: 解释模型输出的相关代码。
  • experiments/: 实验配置和运行脚本。
  • models/: 模型定义和实现。
  • utils/: 工具函数和辅助代码。
• docs/: 项目文档。
• examples/: 示例代码和教程。
• scripts/: 脚本文件，如数据预处理脚本。
• tests/: 测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖包列表。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件通常位于 scripts/ 目录下，例如 run_experiment.py。这个文件用于启动实验，配置模型和数据集，并执行训练和评估。

# scripts/run_experiment.py
import argparse
from dig.experiments import Experiment

def main():
    parser = argparse.ArgumentParser(description="Run an experiment.")
    parser.add_argument("--config", type=str, required=True, help="Path to the config file.")
    args = parser.parse_args()

    experiment = Experiment(args.config)
    experiment.run()

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

配置文件通常位于 configs/ 目录下，以 .yaml 或 .json 格式存储。例如 configs/default_config.yaml：

# configs/default_config.yaml
dataset:
  name: "Cora"
  path: "data/Cora"

model:
  name: "GCN"
  hidden_dim: 16
  num_layers: 2

training:
  epochs: 200
  lr: 0.01
  weight_decay: 5e-4

配置文件定义了数据集、模型和训练参数。在启动文件中，通过读取配置文件来加载这些参数并进行实验。