RecBole 项目安装与使用教程

1. 项目目录结构及介绍

RecBole 项目的目录结构如下：

RecBole/
├── dataset/
│   └── ml-100k/
├── docs/
├── recbole/
├── run_example/
├── tests/
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── README_CN.md
├── hyper_test/
├── requirements.txt
├── run_hyper.py
├── run_recbole.py
├── run_recbole_group.py
├── run_test.sh
├── setup.py
├── significance_test.py
└── style.cfg

目录结构介绍

• dataset/: 存放推荐系统常用的数据集，例如 ml-100k。
• docs/: 存放项目的文档文件。
• recbole/: 核心代码库，包含推荐算法的实现。
• run_example/: 存放运行示例的脚本。
• tests/: 存放测试脚本和测试数据。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包配置文件。
• README.md: 项目英文介绍文件。
• README_CN.md: 项目中文介绍文件。
• hyper_test/: 超参数测试相关文件。
• requirements.txt: 项目依赖库列表。
• run_hyper.py: 超参数搜索脚本。
• run_recbole.py: 推荐算法运行脚本。
• run_recbole_group.py: 推荐算法分组运行脚本。
• run_test.sh: 测试脚本。
• setup.py: 项目安装脚本。
• significance_test.py: 显著性测试脚本。
• style.cfg: 代码风格配置文件。

2. 项目启动文件介绍

run_recbole.py

run_recbole.py 是 RecBole 项目的主要启动文件，用于运行推荐算法模型。该脚本默认会运行 BPR 模型在 ml-100k 数据集上。

使用示例

python run_recbole.py

参数说明

• --model: 指定要运行的推荐算法模型，例如 --model=BPR。
• --dataset: 指定要使用的数据集，例如 --dataset=ml-100k。
• --config_files: 指定配置文件路径，例如 --config_files=config.yaml。

run_hyper.py

run_hyper.py 用于自动搜索最佳超参数。

使用示例

python run_hyper.py --model=BPR --dataset=ml-100k --config_files=config.yaml --params_file=hyper_test

3. 项目配置文件介绍

RecBole 项目的配置文件通常使用 YAML 格式，用于指定模型的超参数、数据集路径、评估设置等。

配置文件示例

# 数据集配置
dataset:
  name: ml-100k
  path: dataset/ml-100k

# 模型配置
model:
  name: BPR
  embedding_size: 64
  learning_rate: 0.001

# 评估配置
evaluation:
  metrics: [recall@10, mrr@10, ndcg@10]
  split_ratio: [0.8, 0.1, 0.1]

配置文件参数说明

• dataset: 数据集相关配置，包括数据集名称和路径。
• model: 模型相关配置，包括模型名称、嵌入大小、学习率等。
• evaluation: 评估相关配置，包括评估指标和数据集分割比例。

通过以上配置文件，用户可以灵活地调整推荐算法的参数和评估设置，以适应不同的研究需求。