CogDL 项目使用教程

1. 项目目录结构及介绍

CogDL 项目的目录结构如下：

CogDL/
├── cogdl/
│   ├── datasets/
│   ├── models/
│   ├── layers/
│   ├── options.py
│   ├── utils.py
│   └── ...
├── docs/
├── examples/
├── scripts/
├── tests/
├── third_party/
├── .flake8
├── .gitignore
├── .gitmodules
├── .pre-commit-config.yaml
├── .readthedocs.yml
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.md
├── README_CN.md
├── gnn_papers.md
├── pyproject.toml
├── results.md
└── setup.py

目录结构介绍

• cogdl/: 核心代码目录，包含数据集、模型、层、配置文件和工具函数等。

  • datasets/: 存放各种图数据集的处理代码。
  • models/: 存放各种图神经网络模型的实现代码。
  • layers/: 存放图神经网络的层实现代码。
  • options.py: 配置选项文件，定义了命令行参数和配置项。
  • utils.py: 工具函数文件，包含一些常用的辅助函数。

• docs/: 项目文档目录，包含项目的详细文档和教程。

• examples/: 示例代码目录，包含一些使用 CogDL 的示例代码。

• scripts/: 脚本目录，包含一些用于训练和测试的脚本。

• tests/: 测试代码目录，包含项目的单元测试代码。

• third_party/: 第三方库目录，包含一些依赖的第三方库。

• .flake8: 代码风格检查配置文件。

• .gitignore: Git 忽略文件配置。

• .gitmodules: Git 子模块配置文件。

• .pre-commit-config.yaml: 预提交钩子配置文件。

• .readthedocs.yml: Read the Docs 配置文件。

• .travis.yml: Travis CI 配置文件。

• LICENSE: 项目许可证文件。

• MANIFEST.in: 打包配置文件。

• README.md: 项目介绍文件，包含项目的概述和使用说明。

• README_CN.md: 中文项目介绍文件。

• gnn_papers.md: 图神经网络相关论文列表。

• pyproject.toml: Python 项目配置文件。

• results.md: 实验结果记录文件。

• setup.py: 项目安装脚本。

2. 项目启动文件介绍

CogDL 项目的启动文件主要位于 scripts/ 目录下，其中 train.py 是最常用的启动文件。

scripts/train.py

train.py 是 CogDL 项目的主要启动文件，用于训练和测试图神经网络模型。通过命令行参数可以指定数据集、模型、超参数等。

使用示例

python scripts/train.py --dataset cora --model gcn --hidden-size 64 --epochs 200

• --dataset: 指定数据集名称，如 cora、citeseer 等。
• --model: 指定模型名称，如 gcn、gat 等。
• --hidden-size: 指定隐藏层大小。
• --epochs: 指定训练轮数。

3. 项目配置文件介绍

CogDL 项目的配置文件主要位于 cogdl/ 目录下，其中 options.py 是主要的配置文件。

cogdl/options.py

options.py 文件定义了命令行参数和配置项，用于控制模型的训练和测试过程。

主要配置项

• dataset: 数据集名称，如 cora、citeseer 等。
• model: 模型名称，如 gcn、gat 等。
• hidden_size: 隐藏层大小。
• epochs: 训练轮数。
• lr: 学习率。
• dropout: 丢弃率。

使用示例

from cogdl import experiment

# 基本用法
experiment(dataset="cora", model="gcn")

# 设置其他超参数
experiment(dataset="cora", model="gcn", hidden_size=32, epochs=200)

通过 options.py 文件，用户可以方便地配置和调整模型的训练参数。