GraphWorld 项目使用教程

GraphWorld 项目使用教程

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

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

graphworld/
├── README.md
├── setup.py
├── requirements.txt
├── graphworld/
│   ├── __init__.py
│   ├── config/
│   │   ├── default_config.yaml
│   │   └── ...
│   ├── data/
│   │   └── ...
│   ├── models/
│   │   └── ...
│   ├── scripts/
│   │   ├── run_experiment.py
│   │   └── ...
│   └── utils/
│       └── ...
└── tests/
    └── ...

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• setup.py: 项目的安装脚本。
• requirements.txt: 项目依赖的Python包列表。
• graphworld/: 项目的主要代码目录。
  • init.py: 初始化文件，使该目录成为一个Python包。
  • config/: 存放项目的配置文件。
    • default_config.yaml: 默认的配置文件。
  • data/: 存放项目的数据文件。
  • models/: 存放项目的模型代码。
  • scripts/: 存放项目的脚本文件。
    • run_experiment.py: 启动实验的脚本文件。
  • utils/: 存放项目的工具函数和辅助代码。
• tests/: 存放项目的测试代码。

2. 项目的启动文件介绍

run_experiment.py

run_experiment.py 是 GraphWorld 项目的主要启动文件，用于启动实验。该脚本会读取配置文件中的参数，生成合成图数据，并训练和测试指定的 GNN 模型。

使用方法

python graphworld/scripts/run_experiment.py --config_file path/to/config.yaml

• --config_file: 指定配置文件的路径。

3. 项目的配置文件介绍

default_config.yaml

default_config.yaml 是 GraphWorld 项目的默认配置文件，包含了实验所需的各种参数设置。

配置文件示例

# 图生成器配置
graph_generator:
  type: "random"
  parameters:
    num_nodes: 1000
    edge_probability: 0.01

# GNN 模型配置
gnn_models:
  - name: "GCN"
    parameters:
      hidden_units: 64
      num_layers: 2

# 实验参数
experiment:
  num_runs: 10
  output_dir: "results/"

配置文件参数说明

• graph_generator: 图生成器的配置。
  • type: 生成器的类型，如 random。
  • parameters: 生成器的参数，如节点数量 num_nodes 和边概率 edge_probability。
• gnn_models: 要测试的 GNN 模型列表。
  • name: 模型的名称，如 GCN。
  • parameters: 模型的参数，如隐藏单元数 hidden_units 和层数 num_layers。
• experiment: 实验的配置。
  • num_runs: 实验的运行次数。
  • output_dir: 实验结果的输出目录。

通过修改配置文件中的参数，用户可以自定义实验的设置，生成不同的图数据并测试不同的 GNN 模型。

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