TensorRec

一个基于 TensorFlow 的 Python 推荐算法与框架。

注意：TensorRec 目前已停止积极开发

TensorRec 将不再进行计划内的更新。不过，欢迎您随时提交 Pull Request，我非常乐意审阅它们。

感谢您对 TensorRec 的贡献、支持和使用！

——詹姆斯·柯克，@jfkirk

如果您在寻找类似的工具，可以查看以下项目：

TensorFlow Ranking

Spotlight

LightFM

什么是 TensorRec？

TensorRec 是一个用 Python 编写的推荐系统，它允许您快速开发推荐算法，并利用 TensorFlow 对其进行自定义。

通过 TensorRec，您可以自定义推荐系统的表示/嵌入函数以及损失函数；同时，TensorRec 会负责数据处理、打分和排序等工作，以生成最终的推荐结果。

TensorRec 系统需要三种输入数据：user_features（用户特征）、item_features（物品特征）和 interactions（交互数据）。它会利用这些数据来学习如何生成并排序推荐结果。

如需了解 TensorRec 的概述及其使用方法，请参阅 wiki 页面。

欲获取更多信息及本项目的整体介绍，请阅读 这篇博客文章。

如需了解构建推荐系统的基础知识，请参阅 这些幻灯片。

示例：基本用法

import numpy as np
import tensorrec

# 使用默认参数构建模型
model = tensorrec.TensorRec()

# 生成一些模拟数据
interactions, user_features, item_features = tensorrec.util.generate_dummy_data(
    num_users=100,
    num_items=150,
    interaction_density=.05
)

# 训练模型 5 个 epoch
model.fit(interactions, user_features, item_features, epochs=5, verbose=True)

# 预测所有用户对所有物品的得分及排名
predictions = model.predict(user_features=user_features,
                            item_features=item_features)
predicted_ranks = model.predict_rank(user_features=user_features,
                                     item_features=item_features)

# 计算并打印召回率（k=10）
r_at_k = tensorrec.eval.recall_at_k(predicted_ranks, interactions, k=10)
print(np.mean(r_at_k))

快速入门

您可以通过 pip 安装 TensorRec： pip install tensorrec

TensorRec 快速上手指南

重要提示：TensorRec 目前已停止主动开发维护。作者建议新项目可考虑使用 TensorFlow Ranking、Spotlight 或 LightFM 等替代方案。本指南仅用于现有项目的快速参考。

环境准备

• 操作系统：Linux、macOS 或 Windows
• Python 版本：建议 Python 3.6+
• 核心依赖：
  • TensorFlow (需预先安装兼容版本)
  • NumPy
  • SciPy

安装步骤

通过 pip 直接安装：

pip install tensorrec

国内加速建议： 如果遇到下载速度慢的问题，推荐使用国内镜像源安装：

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

基本使用

以下是一个完整的最小化示例，展示如何构建模型、生成数据、训练及评估：

import numpy as np
import tensorrec

# 使用默认参数构建模型
model = tensorrec.TensorRec()

# 生成模拟数据 (100 用户，150 物品，交互密度 5%)
interactions, user_features, item_features = tensorrec.util.generate_dummy_data(
    num_users=100,
    num_items=150,
    interaction_density=.05
)

# 训练模型 5 个 epoch
model.fit(interactions, user_features, item_features, epochs=5, verbose=True)

# 预测所有用户对所有物品的评分和排名
predictions = model.predict(user_features=user_features,
                            item_features=item_features)
predicted_ranks = model.predict_rank(user_features=user_features,
                                     item_features=item_features)

# 计算并打印 Recall@10 指标
r_at_k = tensorrec.eval.recall_at_k(predicted_ranks, interactions, k=10)
print(np.mean(r_at_k))

核心概念说明：

• 输入数据：系统需要三部分数据：user_features（用户特征）、item_features（物品特征）和 interactions（交互记录）。
• 自定义能力：你可以自定义嵌入函数（embedding functions）和损失函数（loss functions），框架会自动处理数据操作、评分和排序。