zhenghaoz/gorse-server

Gorse 推荐系统引擎

概述和主要用途

Gorse是用Go编写的开源推荐系统，旨在成为通用的开源推荐系统，可快速引入各种在线服务。通过导入项目、用户和交互数据，系统将自动训练模型为每个用户生成推荐。

!https://github.com/gorse-io/gorse/raw/master/assets/workflow.png

核心功能和特性

• 多源推荐：从热门、最新、基于用户、基于项目和协同过滤中推荐项目。
• AutoML：在后台自动搜索最佳推荐模型。
• 分布式预测：单节点训练后，推荐阶段支持水平扩展。
• RESTful APIs：提供数据CRUD和推荐请求的RESTful API。
• 在线评估：通过最近插入的反馈分析在线推荐性能。
• 仪表板：提供数据管理、系统监控和集群状态检查的GUI。

使用场景和适用范围

适用于需要快速引入推荐系统的各种在线服务，如电商平台、内容推荐、社交网络等，帮助服务为用户提供个性化推荐。

使用方法和配置说明

快速启动

为初学者准备了 playground 模式，通过以下命令为GitHub仓库设置推荐系统：

• Linux/macOS：

bash
curl -fsSL https://gorse.io/playground | bash

• Docker：

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

playground 模式将从 GitRec 下载数据并导入Gorse。仪表板可通过 http://localhost:8088 访问。

!https://github.com/gorse-io/gorse/raw/master/assets/dashboard.jpeg

插入反馈数据

在"Tasks"页面完成"Find neighbors of items"任务后，可插入反馈数据。例如，插入用户"bob"对前端仓库的星标反馈：

bash
read -d '' JSON << EOF
[
    { "FeedbackType": "star", "UserId": "bob", "ItemId": "vuejs:vue", "Timestamp": "2022-02-24" },
    { "FeedbackType": "star", "UserId": "bob", "ItemId": "d3:d3", "Timestamp": "2022-02-25" },
    { "FeedbackType": "star", "UserId": "bob", "ItemId": "dogfalo:materialize", "Timestamp": "2022-02-26" },
    { "FeedbackType": "star", "UserId": "bob", "ItemId": "mozilla:pdf.js", "Timestamp": "2022-02-27" },
    { "FeedbackType": "star", "UserId": "bob", "ItemId": "moment:moment", "Timestamp": "2022-02-28" }
]
EOF

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

获取推荐结果

获取为"bob"推荐的10个项目：

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

json
[
 "mbostock:d3",
 "nt1m:material-framework",
 "mdbootstrap:vue-bootstrap-with-material-design",
 "justice47:f2-vue",
 "10clouds:cyclejs-cookie",
 "academicpages:academicpages.github.io",
 "accenture:alexia",
 "addyosmani:tmi",
 "1wheel:d3-starterkit",
 "acdlite:redux-promise"
]

确切输出可能与示例不同，因为playground数据集会随时间变化。

更多信息：

• 阅读官方文档
• 访问官方演示
• 在***或https://github.com/gorse-io/gorse/discussions%E4%B8%8A%E8%AE%A8%E8%AE%BA

架构

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

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

此外，管理员可通过主节点上的仪表板执行系统监控、数据导入导出和系统状态检查。

!https://github.com/gorse-io/gorse/raw/master/assets/architecture.png

贡献者

欢迎任何贡献：报告错误、提供建议或创建拉取请求。阅读CONTRIBUTING.md了解更多信息。

致谢

gorse 的灵感来自以下项目：

• https://github.com/guoguibing/librec
• https://github.com/NicolasHug/Surprise
• https://github.com/golang-samples/gopher-vector