Gorse 开源推荐系统引擎

Gorse 是一个基于 Go 语言编写的、由 AI 驱动的开源推荐系统。Gorse 的目标是成为一个通用的开源推荐系统，能够快速集成到各种在线服务中。通过将物品、用户和交互数据导入 Gorse，系统会自动训练模型，为每个用户生成个性化推荐。项目的主要特性如下。

• 多源推荐： 支持从最新内容、用户间、物品间以及协同过滤等多种来源进行推荐。
• 多模态支持： 通过嵌入技术支持多模态内容（文本、图片、视频等）。
• AI 驱动： 同时支持传统推荐算法和基于大语言模型的推荐算法。
• GUI 控制台： 提供图形化界面，用于推荐流程编辑、系统监控和数据管理。
• RESTful API： 暴露 RESTful API，用于数据的增删改查及推荐请求。

快速开始

我们为初学者准备了试用模式。只需运行以下命令即可为 GitHub 仓库搭建一个推荐系统。

docker run -p 8088:8088 zhenghaoz/gorse-in-one --playground

试用模式会从 GitRec 下载数据并导入到 Gorse 中。控制台地址为 http://localhost:8088。

在“任务”页面完成“生成物品间推荐”任务后，尝试向 Gorse 插入几条反馈。假设 Bob 是一位对大语言模型相关仓库感兴趣的开发者，我们可以将他的点赞反馈插入到 Gorse 中。

read -d '' JSON << EOF
[
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"ollama:ollama\", \"Value\": 1.0, \"Timestamp\": \"2022-02-24\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"huggingface:transformers\", \"Value\": 1.0, \"Timestamp\": \"2022-02-25\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"rasbt:llms-from-scratch\", \"Value\": 1.0, \"Timestamp\": \"2022-02-26\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"vllm-project:vllm\", \"Value\": 1.0, \"Timestamp\": \"2022-02-27\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"hiyouga:llama-factory\", \"Value\": 1.0, \"Timestamp\": \"2022-02-28\" }
]
EOF

curl -X POST http://127.0.0.1:8088/api/feedback \
   -H 'Content-Type: application/json' \
   -d "$JSON"

然后，从 Gorse 获取 10 条推荐结果。你会发现，Bob 获得的推荐主要都是与大语言模型相关的仓库。

curl http://127.0.0.1:8088/api/recommend/bob?n=10

更多信息：

• 阅读 官方文档
• 访问 Gorse 控制台的 试用版
• 探索 实时演示——一个针对 GitHub 仓库的推荐系统
• 在 Discord 或 GitHub 讨论区 中交流

架构

Gorse 是一个单节点训练、分布式预测的推荐系统。它使用 MySQL、MongoDB、Postgres 或 ClickHouse 存储数据，并将中间结果缓存在 Redis、MySQL、MongoDB 和 Postgres 中。

1. 集群由一个主节点、多个工作节点和服务器节点组成。
2. 主节点负责模型训练、非个性化推荐、配置管理和用户管理。
3. 服务器节点负责暴露 RESTful API 和在线实时推荐。
4. 工作节点负责为每个用户生成离线推荐。

此外，管理员可以通过主节点上的控制台进行系统监控、数据导入导出以及系统状态检查。

贡献者

无论您是报告 bug、提出建议，还是创建 pull request，您的贡献都将受到欢迎。更多详情请参阅 CONTRIBUTING.md。

致谢

gorse 的灵感来源于以下项目：

• Guibing Guo 的 librec
• Nicolas Hug 的 Surprise
• Golang Samples 的 gopher-vector

Gorse 开源推荐系统快速上手指南

Gorse 是一个基于 Go 语言开发的高性能开源推荐系统引擎。它支持多源数据、多模态内容（文本、图像等）以及传统算法与大模型（LLM）结合的推荐策略，并提供可视化的管理仪表盘和 RESTful API。

环境准备

• 操作系统：Linux, macOS, Windows (WSL 推荐)
• 核心依赖：
  • Docker：推荐使用 Docker 进行一键部署（本指南采用此方式）。
  • 若需源码编译，需安装 Go 1.20+。
• 网络要求：初次运行 Playground 模式时，系统会自动从互联网下载示例数据集（GitRec），请确保网络畅通。国内用户若遇到拉取镜像或数据缓慢，建议配置 Docker 镜像加速器。

安装步骤

Gorse 提供了 in-one 镜像，集成了所有组件，最适合快速体验。只需执行以下命令即可启动包含示例数据的游乐场模式（Playground Mode）：

docker run -p 8088:8088 zhenghaoz/gorse-in-one --playground

• 该命令会自动下载并导入 GitHub 仓库推荐数据集。
• 启动完成后，访问 http://localhost:8088 即可打开可视化仪表盘。

基本使用

以下演示如何通过 API 插入用户行为数据并获取个性化推荐结果。

1. 等待任务完成

在仪表盘的 Tasks 页面，等待 "Generate item-to-item recommendation" 任务状态变为完成。

2. 插入用户反馈

假设用户 "bob" 对 LLM 相关的仓库感兴趣，我们通过 API 插入他的点赞（star）记录。执行以下命令：

read -d '' JSON << EOF
[
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"ollama:ollama\", \"Value\": 1.0, \"Timestamp\": \"2022-02-24\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"huggingface:transformers\", \"Value\": 1.0, \"Timestamp\": \"2022-02-25\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"rasbt:llms-from-scratch\", \"Value\": 1.0, \"Timestamp\": \"2022-02-26\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"vllm-project:vllm\", \"Value\": 1.0, \"Timestamp\": \"2022-02-27\" },
    { \"FeedbackType\": \"star\", \"UserId\": \"bob\", \"ItemId\": \"hiyouga:llama-factory\", \"Value\": 1.0, \"Timestamp\": \"2022-02-28\" }
]
EOF

curl -X POST http://127.0.0.1:8088/api/feedback \
   -H 'Content-Type: application/json' \
   -d "$JSON"

3. 获取推荐结果

请求 Gorse 为 "bob" 生成 10 个推荐项。系统将基于他刚才的反馈，返回相关的 LLM 仓库列表：

curl http://127.0.0.1:8088/api/recommend/bob?n=10

---

更多资源：

• 官方文档
• 在线演示 (GitRec)
• Discord 社区