OpenHGNN 开源项目教程

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

OpenHGNN 项目的目录结构如下：

OpenHGNN/
├── README.md
├── setup.py
├──openhgnn/
│   ├── __init__.py
│   ├── config.py
│   ├── main.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── baseline.py
│   │   └── hgnn.py
│   ├── outputs/
│   │   └── ...
│   ├── scripts/
│   │   └── ...
│   └── utils/
│       ├── __init__.py
│       ├── metrics.py
│       └── utils.py
└── tests/
    └── ...

目录结构介绍

• README.md: 项目介绍和使用说明。
• setup.py: 项目安装脚本。
• openhgnn/: 项目主目录。
  • __init__.py: 初始化文件。
  • config.py: 配置文件。
  • main.py: 项目启动文件。
  • models/: 存放模型相关文件。
    • baseline.py: 基线模型。
    • hgnn.py: HGNN 模型。
  • outputs/: 存放输出文件。
  • scripts/: 存放脚本文件。
  • utils/: 存放工具函数。
    • metrics.py: 评估指标。
    • utils.py: 通用工具函数。
• tests/: 存放测试文件。

2. 项目的启动文件介绍

项目的启动文件是 openhgnn/main.py。该文件负责启动整个项目，包括加载配置、初始化模型、训练和评估等步骤。

主要功能

• 加载配置文件：从 config.py 中读取配置信息。
• 初始化模型：根据配置信息初始化相应的模型。
• 训练模型：执行训练过程，包括前向传播、反向传播和参数更新。
• 评估模型：在验证集或测试集上评估模型性能。

3. 项目的配置文件介绍

项目的配置文件是 openhgnn/config.py。该文件定义了项目运行所需的各种配置参数。

主要配置项

• model_name: 指定使用的模型名称。
• dataset_name: 指定使用的数据集名称。
• learning_rate: 学习率。
• num_epochs: 训练轮数。
• batch_size: 批次大小。
• hidden_dim: 隐藏层维度。
• num_layers: 模型层数。
• dropout: dropout 比例。
• device: 指定使用的设备（CPU 或 GPU）。

通过修改这些配置项，可以灵活地调整模型和训练过程的参数。