GSAT 项目使用教程

1. 项目目录结构及介绍

GSAT 项目的目录结构如下：

GSAT/
├── data/
│   └── example/
├── src/
│   ├── configs/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── run_gsat.py

目录结构介绍

• data/: 存放数据文件的目录，包含示例数据。
• src/: 项目的源代码目录，包含配置文件和其他源代码文件。
  • configs/: 存放项目的配置文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• requirements.txt: 项目依赖的 Python 包列表。
• run_gsat.py: 项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件是 run_gsat.py。该文件用于运行 GSAT 模型，并提供了命令行参数来指定数据集、模型类型和使用的 GPU。

启动文件的使用方法

python run_gsat.py --dataset [dataset_name] --backbone [model_name] --cuda [GPU_id]

• --dataset: 指定要使用的数据集名称，例如 ba_2motifs, mutag, mnist 等。
• --backbone: 指定要使用的模型类型，例如 GIN, PNA 等。
• --cuda: 指定要使用的 GPU ID，如果使用 CPU，则设置为 -1。

3. 项目的配置文件介绍

项目的配置文件存放在 src/configs/ 目录下。这些配置文件用于设置模型的超参数、数据路径等。

配置文件示例

# src/configs/default.py

# 数据集路径
DATASET_PATH = "data/"

# 模型超参数
HIDDEN_DIM = 128
NUM_LAYERS = 3

# 训练参数
EPOCHS = 100
BATCH_SIZE = 32
LEARNING_RATE = 0.001

配置文件的使用

在 run_gsat.py 中，可以通过导入配置文件来使用这些参数：

from src.configs import default

# 使用配置文件中的参数
dataset_path = default.DATASET_PATH
hidden_dim = default.HIDDEN_DIM

通过这种方式，可以方便地管理和修改项目的配置。