Role2Vec 项目教程

1. 项目目录结构及介绍

Role2Vec 项目的目录结构如下：

role2vec/
├── input/
│   └── cora_edges.csv
├── output/
├── src/
│   └── main.py
├── LICENSE
├── README.md
├── orbit.png
├── paper.pdf
└── role2vec_run.jpg

目录结构介绍

• input/: 存放输入数据文件的目录，包含一个示例图的边列表文件 cora_edges.csv。
• output/: 存放输出结果文件的目录，默认情况下，生成的嵌入文件会保存在这里。
• src/: 源代码目录，包含项目的核心代码文件 main.py。
• LICENSE: 项目的许可证文件，采用 GPL-3.0 许可证。
• README.md: 项目的说明文件，包含项目的简介、使用方法和依赖信息。
• orbit.png: 项目相关的图片文件。
• paper.pdf: 项目相关的论文文件。
• role2vec_run.jpg: 项目相关的图片文件。

2. 项目启动文件介绍

项目的启动文件是 src/main.py。该文件是 Role2Vec 模型的主要执行脚本，负责加载数据、训练模型并生成嵌入结果。

启动文件功能

• 数据加载: 从 input/ 目录中加载图的边列表数据。
• 模型训练: 使用 Role2Vec 算法训练图嵌入模型。
• 结果保存: 将生成的嵌入结果保存到 output/ 目录中。

启动命令

python src/main.py

3. 项目配置文件介绍

Role2Vec 项目没有单独的配置文件，所有的配置参数都是通过命令行参数传递的。以下是一些常用的命令行参数及其默认值：

常用配置参数

• --graph-input STR: 输入图的路径，默认值为 input/cora_edges.csv。
• --output STR: 嵌入结果的保存路径，默认值为 output/cora_role2vec.csv。
• --window-size INT: Skip-gram 窗口大小，默认值为 5。
• --walk-number INT: 每个节点的随机游走次数，默认值为 10。
• --walk-length INT: 每次随机游走的节点数，默认值为 80。
• --dimensions INT: 嵌入维度，默认值为 128。
• --epochs INT: 训练轮数，默认值为 10。

示例配置

python src/main.py --graph-input input/custom_graph.csv --output output/custom_embedding.csv --dimensions 64 --epochs 20

以上命令将使用 input/custom_graph.csv 作为输入数据，生成 64 维的嵌入结果，并保存到 output/custom_embedding.csv 文件中，训练轮数为 20 轮。