GraphGym 项目使用教程

GraphGym 项目使用教程

项目地址:https://gitcode.com/gh_mirrors/gr/GraphGym

1. 项目目录结构及介绍

GraphGym 项目的目录结构如下：

GraphGym/
├── analysis/
├── docs/
├── graphgym/
├── run/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── install.sh
├── requirements.txt
└── setup.py

目录结构介绍：

• analysis/: 包含项目分析相关的文件和脚本。
• docs/: 包含项目的文档文件。
• graphgym/: 包含 GraphGym 的核心代码和模块。
• run/: 包含项目的启动脚本和配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• install.sh: 项目安装脚本。
• requirements.txt: 项目依赖包列表。
• setup.py: 项目安装和配置脚本。

2. 项目启动文件介绍

GraphGym 项目的启动文件主要位于 run/ 目录下，常用的启动脚本包括：

• run_single.sh: 用于启动单个 GNN 实验。
• run_batch.sh: 用于启动批量 GNN 实验。
• run_single_cpu.sh: 用于在 CPU 上启动单个 GNN 实验。
• run_single_pyg.sh: 用于使用 PyG 后端启动单个 GNN 实验。
• run_batch_pyg.sh: 用于使用 PyG 后端启动批量 GNN 实验。

启动文件介绍：

• run_single.sh:

  cd run
  bash run_single.sh
  

  该脚本用于启动单个 GNN 实验，配置文件在 run/configs/example.yaml 中指定。

• run_batch.sh:

  cd run
  bash run_batch.sh
  

  该脚本用于启动批量 GNN 实验，配置文件在 run/configs/example.yaml 和 run/configs/example.txt 中指定。

3. 项目的配置文件介绍

GraphGym 项目的配置文件主要位于 run/configs/ 目录下，常用的配置文件包括：

• example.yaml: 用于指定单个 GNN 实验的配置。
• example.txt: 用于指定批量 GNN 实验的配置。

配置文件介绍：

• example.yaml: 该文件包含了 GNN 实验的详细配置，包括数据集、训练参数、模型结构、GNN 层配置等。未指定的配置项将使用 graphgym/config.py 中的默认值。

• example.txt: 该文件用于指定批量 GNN 实验的配置，控制如何进行网格搜索。

配置文件示例：

# example.yaml
dataset:
  name: Cora
  split: random

training:
  epochs: 200
  batch_size: 32

model:
  type: GCN
  layers: 2

gnn:
  hidden_dim: 128
  dropout: 0.5

通过以上配置文件，可以灵活地调整 GNN 实验的参数和设置。

GraphGym Platform for designing and evaluating Graph Neural Networks (GNN) 项目地址: https://gitcode.com/gh_mirrors/gr/GraphGym