Recbole安装及使用

一、简介

　　RecBole（中文名称：“伯乐”），由中国人民大学AI Box团队和北京邮电大学、华东师范大学团队联合开发的Pytorch推荐系统开源库。

　　该框架实现了推荐领域不同任务推荐模型，上手快，易操作。

　　包含以下功能：

• 53种模型（绝大部分为最新的深度学习模型）
• 27个数据集合（涵盖了四种任务下最常用的实验数据集合）
• 多种评测方式（涵盖所有主流的评测方式，支持一键设置）。
• 自动调参（内嵌实用超参搜索算法，支持灵活设置范围）

　　这个工具包可以满足大部分推荐相关的科研需求。

　　论文：RecBole: Towards a Unified, Comprehensive and Efficient Framework for Recommendation Algorithms

　　主页：https://recbole.io/

　　GitHub：RecBole/README_CN.md at master · RUCAIBox/RecBole · GitHub

　   项目交流邮件：recbole@outlook.com

　　目前RecBole支持 6 种原子文件，他们通过后缀名进行区分：

　　

二、安装

　　官方安装手册：安装 | 伯乐 (recbole.io)

　　注：RecBole需要在python 3.6或更高的环境下运行，RecBole要求torch版本在1.7.0及以上。

　　1、从Conda安装

　　　　 conda install -c aibox recbole 

　　　实际安装如下：   

　　2、从pip安装

　　 pip install recbole 

　　3、从源文件安装

 　　从GitHub上下载源文件：

　　 git clone https://github.com/RUCAIBox/RecBole.git && cd RecBole 

　　运行如下指令进行安装：

　　 pip install -e . --verbose 

三、使用

　（1）从API快速上手

　　如果使用pip或Conda安装RecBole，需要建立一个python文件，如【run.py】，文件中写入如下代码：

from recbole.quick_start 
import run_recbole run_recbole()

　　然后执行如下命令：

　　 python run.py --dataset=ml-100k --model=BPR 

　　就会在ml-100k这个数据集上进行BPR模型的训练和测试。

　　 python run.py --dataset=[dataset_name] --model=[model_name] 

　　或

　　from recbole.quick_start import run_recbole
　　run_recbole(dataset='ml-100k', model='BPR')

　　（2）从源文件快速上手

　　如果从GitHub下载了RecBole的源码，可以使用提供的脚本进行简单的使用：

　　 python run_recbole.py 

　　如果使用提供的 quick start 方式运行 RecBole，则原始数据会被分为训练集、验证集和测试集三个部分。在训练集上进行参数更新，选择在验证集上效果最佳的模型参数，最后报告其在测试集上的结果。

　　如果要改参数，例如learning_rate, embedding_size, 只需根据需求增加额外的参数，例如：

　　 python run_recbole.py --learning_rate=0.0001 --embedding_size=128 

　　如果想改变运行模型，只需要在执行脚本时添加额外的设置参数即可：

　　 python run_recbole.py --model=[model_name]