Surprise - 专为推荐系统设计的Python科学计算工具包

概述

Surprise 是一个用于构建和分析处理显式评分数据的推荐系统的 Python scikit。

Surprise 在设计时考虑了以下目的：

让用户完全掌控他们的实验。为此，我们特别强调文档的重要性，努力使其尽可能清晰准确，指出算法的每个细节。
减轻数据集处理的痛苦。用户可以使用内置数据集（Movielens、Jester）和他们自己的自定义数据集。
提供各种现成的预测算法，如基线算法、邻域方法、基于矩阵分解的算法（SVD、PMF、SVD++、NMF）以及许多其他算法。此外，还内置了各种相似度度量（余弦、MSD、皮尔逊等）。
使新算法思想的实现变得容易。
提供工具来评估、分析和比较算法性能。使用强大的 CV 迭代器（受 scikit-learn 优秀工具的启发），可以非常轻松地运行交叉验证程序，还可以对一组参数进行穷举搜索。

SurPRISE 这个名字（大致）代表 Simple Python RecommendatIon System Engine（简单 Python 推荐系统引擎）。

请注意，Surprise 不支持隐式评分或基于内容的信息。

入门示例

这里有一个简单的例子，展示了如何（下载）加载数据集，将其分割为 5 折交叉验证，并计算 SVD 算法的 MAE 和 RMSE。

from surprise import SVD
from surprise import Dataset
from surprise.model_selection import cross_validate

# 加载 movielens-100k 数据集（如果需要则下载）。
data = Dataset.load_builtin('ml-100k')

# 使用著名的 SVD 算法。
algo = SVD()

# 运行 5 折交叉验证并打印结果。
cross_validate(algo, data, measures=['RMSE', 'MAE'], cv=5, verbose=True)

输出：

在 5 个分割上评估算法 SVD 的 RMSE、MAE。
折1   折2   折3   折4   折5   平均值 标准差

RMSE (测试集)    0.9367 0.9355 0.9378 0.9377 0.9300 0.9355 0.0029
MAE (测试集)     0.7387 0.7371 0.7393 0.7397 0.7325 0.7375 0.0026
拟合时间          0.62   0.63   0.63   0.65   0.63   0.63   0.01
测试时间          0.11   0.11   0.14   0.14   0.14   0.13   0.02

Surprise可以做更多事情(例如,GridSearchCV)! 你可以在文档中找到更多使用示例。

基准测试

以下是各种算法(使用默认参数)在5折交叉验证过程中的平均RMSE、MAE和总执行时间。数据集是Movielens 100k和1M数据集。所有算法使用相同的折叠。所有实验都在配备英特尔i5第11代2.60GHz处理器的笔记本电脑上运行。生成这些表格的代码可以在基准测试示例中找到。

Movielens 100k	RMSE	MAE	时间
SVD	0.934	0.737	0:00:06
SVD++ (cache_ratings=False)	0.919	0.721	0:01:39
SVD++ (cache_ratings=True)	0.919	0.721	0:01:22
NMF	0.963	0.758	0:00:06
Slope One	0.946	0.743	0:00:09
k-NN	0.98	0.774	0:00:08
Centered k-NN	0.951	0.749	0:00:09
k-NN Baseline	0.931	0.733	0:00:13
Co-Clustering	0.963	0.753	0:00:06
Baseline	0.944	0.748	0:00:02
Random	1.518	1.219	0:00:01
Movielens 1M	RMSE	MAE	时间
:----------------------------------------------------------------------------------------------------------------------------------------	-------:	------:	:--------
SVD	0.873	0.686	0:01:07
SVD++ (cache_ratings=False)	0.862	0.672	0:41:06
SVD++ (cache_ratings=True)	0.862	0.672	0:34:55
NMF	0.916	0.723	0:01:39
Slope One	0.907	0.715	0:02:31
k-NN	0.923	0.727	0:05:27
Centered k-NN	0.929	0.738	0:05:43
k-NN Baseline	0.895	0.706	0:05:55
Co-Clustering	0.915	0.717	0:00:31
Baseline	0.909	0.719	0:00:19
Random	1.504	1.206	0:00:19

安装

使用pip安装（您需要C编译器。Windows用户可能更喜欢使用conda）：

$ pip install scikit-surprise

使用conda安装：

$ conda install -c conda-forge scikit-surprise

对于最新版本，您也可以克隆仓库并从源码构建（您首先需要安装Cython和numpy）：

$ git clone https://github.com/NicolasHug/surprise.git
$ cd surprise
$ pip install .

许可证和引用

本项目采用BSD 3-Clause许可证，因此可以用于几乎所有用途，包括商业应用。

我很想知道Surprise对您有何用处。请不要犹豫，开一个issue来描述您是如何使用它的！

如果您在研究中使用Surprise，请务必引用这篇论文：

@article{Hug2020,
  doi = {10.21105/joss.02174},
  url = {https://doi.org/10.21105/joss.02174},
  year = {2020},
  publisher = {The Open Journal},
  volume = {5},
  number = {52},
  pages = {2174},
  author = {Nicolas Hug},
  title = {Surprise: A Python library for recommender systems},
  journal = {Journal of Open Source Software}
}

贡献者

以下人员为Surprise做出了贡献：

ashtou, Abhishek Bhatia, bobbyinfj, caoyi, Chieh-Han Chen, Raphael-Dayan, Олег Демиденко, Charles-Emmanuel Dias, dmamylin, Lauriane Ducasse, Marc Feger, franckjay, Lukas Galke, Tim Gates, Pierre-François Gimenez, Zachary Glassman, Jeff Hale, Nicolas Hug, Janniks, jyesawtellrickson, Doruk Kilitcioglu, Ravi Raju Krishna, lapidshay, Hengji Liu, Ravi Makhija, Maher Malaeb, Manoj K, James McNeilis, Naturale0, nju-luke, Pierre-Louis Pécheux, Jay Qi, Lucas Rebscher, Craig Rodrigues, Skywhat, Hercules Smith, David Stevens, Vesna Tanko, TrWestdoor, Victor Wang, Mike Lee Williams, Jay Wong, Chenchen Xu, YaoZh1918.

非常感谢！:)

开发状态

从1.1.0版本（2019年9月）开始，我将只维护该软件包，提供bug修复，可能偶尔进行性能改进。我现在能投入的时间较少，所以无法考虑新功能。

对于Surprise的bug、问题或疑问，请避免给我发邮件（我可能无法回复）。请使用GitHub项目页面，这样其他人也可以从中受益。