LightFM

构建状态
Linux
OSX (OpenMP已禁用)
Windows (OpenMP已禁用)

LightFM 是一种 Python 实现，支持多种流行的推荐算法，适用于隐式和显式反馈场景，包括高效的 BPR 和 WARP 排序损失的实现。它易于使用、速度快（通过多线程模型估计）且能产生高质量的推荐结果。

此外，LightFM 还允许将物品和用户的元数据整合到传统的矩阵分解算法中。它将每个用户和物品表示为其特征潜在表示的加权和，从而使得推荐能够泛化到新物品（通过物品特征）和新用户（通过用户特征）。

更多详细信息，请参阅 文档。

需要帮助？请通过 电子邮件、Twitter 或 Gitter 联系我。

安装

使用 pip 安装：

pip install lightfm

或使用 Conda：

conda install -c conda-forge lightfm

快速入门

在 MovieLens 100k 数据集上拟合一个隐式反馈模型非常简单：

from lightfm import LightFM
from lightfm.datasets import fetch_movielens
from lightfm.evaluation import precision_at_k

# 加载 MovieLens 100k 数据集。仅将五星评分视为正例。
data = fetch_movielens(min_rating=5.0)

# 实例化并训练模型
model = LightFM(loss='warp')
model.fit(data['train'], epochs=30, num_threads=2)

# 评估训练好的模型
test_precision = precision_at_k(model, data['test'], k=5).mean()

关于 LightFM 的文章和教程

1. 使用 LightFM 对 Sketchfab 模型进行排序学习
2. 用于用户和物品冷启动推荐的元数据嵌入
3. 推荐系统——学习 Python 进行数据科学
4. 使用 LightFM 向顾问推荐项目

如何引用

如果您在研究中使用了 LightFM，请引用它。您可以使用以下 BibTeX 条目：

@inproceedings{DBLP:conf/recsys/Kula15,
  author    = {Maciej Kula},
  editor    = {Toine Bogers and
               Marijn Koolen},
  title     = {Metadata Embeddings for User and Item Cold-start Recommendations},
  booktitle = {Proceedings of the 2nd Workshop on New Trends on Content-Based Recommender
               Systems co-located with 9th {ACM} Conference on Recommender Systems
               (RecSys 2015), Vienna, Austria, September 16-20, 2015.},
  series    = {{CEUR} Workshop Proceedings},
  volume    = {1448},
  pages     = {14--21},
  publisher = {CEUR-WS.org},
  year      = {2015},
  url       = {http://ceur-ws.org/Vol-1448/paper4.pdf},
}

开发

欢迎提交 Pull 请求。要进行开发环境的安装：

1. 克隆仓库：git clone git@github.com:lyst/lightfm.git
2. 设置虚拟环境：cd lightfm && python3 -m venv venv && source ./venv/bin/activate
3. 使用 pip 安装开发依赖：pip install -e . && pip install -r test-requirements.txt
4. 可以通过运行 ./venv/bin/py.test tests 来执行测试。
5. LightFM 使用 black 来强制代码格式化，并使用 flake8 进行代码检查，具体可参考 lint-requirements.txt。
6. [可选]：您也可以安装 pre-commit 工具，在本地强制执行代码格式化和检查。安装方法如下：

   pip install pre-commit
   pre-commit install
   

当修改 .pyx 扩展文件时，需要先运行 python setup.py cythonize 以生成扩展的 .c 文件，然后再运行 pip install -e .。

LightFM 快速上手指南

LightFM 是一个高效的 Python 推荐系统库，支持隐式和显式反馈。它实现了 BPR 和 WARP 等流行算法，并独特地支持将用户和物品的元数据（特征）融入矩阵分解中，有效解决冷启动问题。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：推荐 Python 3.6+
• 前置依赖：
  • numpy
  • scipy
  • Cython (开发或从源码安装时需要)
  • scikit-learn
• 编译工具：Windows 用户需安装 Microsoft C++ Build Tools；Linux/macOS 通常需安装 gcc 或 clang。

注意：LightFM 包含 Cython 扩展，建议直接使用预编译包安装以避免编译错误。

安装步骤

推荐使用国内镜像源加速安装。

方式一：使用 pip 安装（推荐）

pip install lightfm -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：使用 Conda 安装

如果你使用 Anaconda 或 Miniconda：

conda install -c conda-forge lightfm

基本使用

以下示例演示如何使用 LightFM 在 MovieLens 数据集上训练一个基于隐式反馈的模型，并评估其准确率。

from lightfm import LightFM
from lightfm.datasets import fetch_movielens
from lightfm.evaluation import precision_at_k

# 1. 加载数据
# 加载 MovieLens 100k 数据集，仅将 5 星评分视为正反馈
data = fetch_movielens(min_rating=5.0)

# 2. 初始化并训练模型
# 使用 'warp' 损失函数，训练 30 个 epoch，开启 2 个线程加速
model = LightFM(loss='warp')
model.fit(data['train'], epochs=30, num_threads=2)

# 3. 评估模型
# 计算前 5 个推荐结果的精确率 (Precision@K)
test_precision = precision_at_k(model, data['test'], k=5).mean()

print(f"Precision@5: {test_precision}")

核心功能提示

• 损失函数选择：loss 参数可选 'bpr' (贝叶斯个性化排序), 'warp' (加权近似排名对), 'logistic' 等。对于隐式反馈，'warp' 通常效果最佳。
• 利用元数据：LightFM 的核心优势在于支持 item_features 和 user_features 稀疏矩阵。在调用 fit 或 predict 时传入这些特征矩阵，即可让模型学习物品和用户的属性表示，从而推荐给新用户或新物品。