NeuRec

一个开源的神经网络推荐库

主要贡献者: Bin Wu、Zhongchuan Sun、Xiangnan He、Xiang Wang 和 Jonathan Staniforth

NeuRec 是一个全面且灵活的 Python 推荐系统库，包含大量最先进的神经网络推荐模型。该库旨在解决通用推荐、社交推荐以及序列化（即下一个物品）推荐任务，并基于 TensorFlow 提供 33 种开箱即用的模型。NeuRec 是 开源 的，采用 MIT 许可证。

特性

• 跨平台 - 可在任何操作系统上运行，提供可用的 Docker 镜像；
• 最先进 - 开箱即用 33 种神经网络推荐模型；
• 灵活配置 - 轻松调整配置以满足您的具体需求；
• 易于扩展 - 可快速将新模型或数据集集成到 NeuRec 中；
• 快速执行 - 自然支持 GPU，并配备多线程评估器；
• 详细文档 - 提供丰富的 Jupyter 笔记本形式的文档，详见 tutorial.ipynb。

架构

NeuRec 的架构如下图所示：

快速入门

首先，下载本仓库并将源代码解压到合适的位置。

其次，进入 ./NeuRec 目录，使用以下命令行编译 C++ 实现的评估器：

python setup.py build_ext --inplace

如果编译成功，将自动调用 C++ 实现的评估器；否则，将调用 Python 实现的评估器。

请注意，C++ 实现的速度远快于 Python。

第三步，在配置文件 NeuRec.properties 中指定数据集和推荐算法。

最后，在 IDE 中或通过命令行运行 main.py：

python main.py

教程

关于 NeuRec 的简要介绍，请参阅 tutorial.ipynb。

模型

NeuRec 中可用的模型列表及其论文引用如下：

通用推荐算法	论文
GMF、MLP、NeuMF	Xiangnan He 等人，《神经协同过滤》，WWW 2017。
BPRMF	Steffen Rendle 等人，《BPR：基于隐式反馈的贝叶斯个性化排序》。UAI 2009。
FISM	Santosh Kabbur 等人，《FISM：用于 Top-N 推荐系统的因子化物品相似度模型》。KDD 2013。
NAIS	Xiangnan He 等人，《NAIS：用于推荐的神经注意力物品相似度模型》。TKDE 2018。
DeepICF	Feng Xue 等人，《用于 Top-N 推荐的深度基于物品的协同过滤》。TOIS 2019。
ConvNCF	Xiangnan He 等人，《基于外积的神经协同过滤》。IJCAI 2018。
DMF	Hong-Jian Xue 等人，《用于推荐系统的深度矩阵分解模型》。IJCAI 2017。
CDAE、DAE	Yao Wu 等人，《用于 Top-N 推荐系统的协同去噪自编码器》。WSDM 2016。
MultiDAE、MultiVAE	Dawen Liang 等人，《用于协同过滤的变分自编码器》。WWW 2018。
JCA	Ziwei Zhu 等人，《通过联合协同自编码器改进 Top-K 推荐》。WWW 2019。
IRGAN	Jun Wang 等人，《IRGAN：一种统一生成与判别信息检索模型的极小极大博弈》。SIGIR 2017。
CFGAN	Dong-Kyu Chae 等人，《CFGAN：基于生成对抗网络的通用协同过滤框架》。CIKM 2018。
APR	Xiangnan He 等人，《用于推荐的对抗性个性化排序》。SIGIR 2018。
SpectralCF	Lei Zheng 等人，《谱协同过滤》。RecSys 2018。
NGCF	Xiang Wang 等人，《神经图协同过滤》。SIGIR 2019。
WRMF	Yifan Hu 等人，《针对隐式反馈数据集的协同过滤》。ICDM 2008。
LightGCN	Xiangnan He 等人，《LightGCN：简化并增强用于推荐的图卷积网络》。SIGIR 2020。

社交推荐算法	论文
SBPR	Tong Zhao 等人，《利用社交关系提升协同过滤的个性化排序》。CIKM 2014。
DiffNet	Le Wu 等人，《用于社交推荐的神经影响力扩散模型》，SIGIR 2019。

序列推荐算法	论文
FPMC、FPMCplus	Steffen Rendle 等人，《为下一次购物篮推荐而分解个性化马尔可夫链》，WWW 2010。
HRM	Pengfei Wang 等人，《学习用于下一次购物篮推荐的层次表示模型》，SIGIR 2015。
NPE	ThaiBinh Nguyen 等人，《NPE：用于协同过滤的神经个性化嵌入》，ijcai 2018。
TransRec	Ruining He 等人，《基于翻译的推荐》，SIGIR 2015。
Caser	Jiaxi Tang 等人，《通过卷积序列嵌入实现个性化 Top-N 序列推荐》，WSDM 2018。
Fossil	Ruining He 等人，《将相似度模型与马尔可夫链融合用于稀疏序列推荐》，ICDM 2016。
GRU4Rec	Balázs Hidasi 等人，《使用循环神经网络进行会话级推荐》，ICLR 2016。
GRU4RecPlus	Balázs Hidasi 等人，《具有 Top-k 增益的循环神经网络用于会话级推荐》，CIKM 2018。
SASRec	Wangcheng Kang 等人，《自注意力序列推荐》，ICDM 2018。
SRGNN	Shu Wu 等人，《使用图神经网络进行会话级推荐》，AAAI 2019。

致谢

NeuRec 的开发得到了中国国家自然科学基金（项目编号：61772475）的支持。本项目还得到了新加坡总理办公室下属的国家研究基金会通过其 IRC@Singapore 资助计划的支持。

NeuRec 快速上手指南

NeuRec 是一个基于 TensorFlow 的开源神经推荐系统库，内置 33 种前沿模型，支持通用推荐、社交推荐及序列推荐（下一项预测）任务。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows（推荐使用 Docker 以实现跨平台运行）。
• 核心依赖：
  • Python (建议 3.6+)
  • TensorFlow
  • C++ 编译器（用于编译高性能评估器，如 gcc 或 g++；若未安装将自动降级为纯 Python 实现，但速度较慢）。
• 可选加速：支持 GPU 加速（需安装对应的 tensorflow-gpu 版本）。

提示：国内用户建议使用清华源或阿里源安装 Python 依赖，以提升下载速度：

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

1. 克隆代码库 将仓库下载到本地并解压至合适目录：

   git clone https://github.com/wubinzzu/NeuRec.git
   cd NeuRec
   

2. 编译 C++ 评估器（强烈推荐） 为了获得最快的评估速度，需编译 C++ 实现的评估模块。在项目根目录下执行：

   python setup.py build_ext --inplace
   

   • 成功：系统将自动调用高效的 C++ 评估器。
   • 失败：若编译出错（如缺少编译器），系统将自动回退到纯 Python 评估器，但运行效率会显著降低。

3. 安装 Python 依赖 确保已安装 tensorflow 及其他必要库：

   pip install -r requirements.txt
   

基本使用

NeuRec 通过配置文件驱动，无需修改代码即可切换数据集和模型。

1. 配置任务 打开项目根目录下的 NeuRec.properties 文件，修改以下关键参数以指定数据集和模型：

   # 示例：指定数据集名称
   dataset = your_dataset_name
   
   # 示例：指定推荐模型（如 NeuMF, LightGCN, SASRec 等）
   recommender = NeuMF
   

   具体可用的数据集和模型名称请参考官方文档或 config 目录下的示例。

2. 运行模型 配置完成后，直接在命令行或 IDE 中运行主程序：

   python main.py
   

3. 深入学习 如需了解详细的参数配置、自定义模型或数据处理流程，请查阅项目自带的 Jupyter Notebook 教程：

   # 在 Jupyter 中打开 tutorial.ipynb
   jupyter notebook tutorial.ipynb