docs: recover README

gorse-io · Oct 16, 2024 · f9990e0 · f9990e0
1 parent dd3d867
commit f9990e0
Showing 1 changed file with 123 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,123 @@
-> [!CAUTION]
-> Still in development. Not ready for production use.
+# Gorse Recommender System Engine
+
+<img width=160 src="assets/gorse.png"/>
+
+![](https://img.shields.io/github/go-mod/go-version/zhenghaoz/gorse)
+[![build](https://github.com/zhenghaoz/gorse/workflows/build/badge.svg)](https://github.com/zhenghaoz/gorse/actions?query=workflow%3Abuild)
+[![codecov](https://codecov.io/gh/gorse-io/gorse/branch/master/graph/badge.svg)](https://codecov.io/gh/gorse-io/gorse)
+[![Go Report Card](https://goreportcard.com/badge/github.com/zhenghaoz/gorse)](https://goreportcard.com/report/github.com/zhenghaoz/gorse)
+[![GoDoc](https://godoc.org/github.com/zhenghaoz/gorse?status.svg)](https://godoc.org/github.com/zhenghaoz/gorse)
+[![Discord](https://img.shields.io/discord/830635934210588743)](https://discord.gg/x6gAtNNkAE)
+[![Twitter Follow](https://img.shields.io/twitter/follow/gorse_io?label=Follow&style=social)](https://twitter.com/gorse_io)
+
+Gorse is an open-source recommendation system written in Go. Gorse aims to be a universal open-source recommender system that can be quickly introduced into a wide variety of online services. By importing items, users, and interaction data into Gorse, the system will automatically train models to generate recommendations for each user. Project features are as follows.
+
+<img width=520 src="assets/workflow.png"/>
+
+- **Multi-source:** Recommend items from Popular, latest, user-based, item-based and collaborative filtering.
+- **AutoML:** Search the best recommendation model automatically in the background.
+- **Distributed prediction:** Support horizontal scaling in the recommendation stage after single node training.
+- **RESTful APIs:** Expose RESTful APIs for data CRUD and recommendation requests.
+- **Online evaluation:** Analyze online recommendation performance from recently inserted feedback.
+- **Dashboard:** Provide GUI for data management, system monitoring, and cluster status checking.
+
+## Quick Start
+
+The playground mode has been prepared for beginners. Just set up a recommender system for GitHub repositories by the following commands. 
+
+- Linux/macOS:
+
+```bash
+curl -fsSL https://gorse.io/playground | bash
+```
+
+- Docker:
+
+```bash
+docker run -p 8088:8088 zhenghaoz/gorse-in-one --playground
+```
+
+The playground mode will download data from [GitRec](https://gitrec.gorse.io/) and import it into Gorse. The dashboard is available at `http://localhost:8088`.
+
+<img width=720 src="assets/dashboard.jpeg"/>
+
+After the "Find neighbors of items" task is completed on the "Tasks" page, try to insert several feedbacks into Gorse. Suppose Bob is a frontend developer who starred several frontend repositories in GitHub. We insert his star feedback to Gorse.
+
+```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"
+                          ```
+
+                          Then, fetch 10 recommended items from Gorse. We can find that frontend-related repositories are recommended for Bob.
+
+                          ```bash
+                          curl http://127.0.0.1:8088/api/recommend/bob?n=10
+                          ```
+
+                          <details>
+                          <summary>Example outputs:</summary>
+
+                          ```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"
+                                    ]
+                                    ```
+
+                                    </details>
+
+                                    > The exact output might be different from the example since the playground dataset changes over time.
+
+                                    For more information：
+
+                                    - Read [official documents](https://gorse.io/docs/master)
+                                    - Visit [official demo](https://gitrec.gorse.io/)
+                                    - Discuss on [Discord](https://discord.gg/x6gAtNNkAE) or [GitHub Discussion](https://github.com/gorse-io/gorse/discussions)
+
+                                    ## Architecture
+
+                                    Gorse is a single-node training and distributed prediction recommender system. Gorse stores data in MySQL, MongoDB, or Postgres, with intermediate results cached in Redis, MySQL, MongoDB and Postgres.
+
+                                    1. The cluster consists of a master node, multiple worker nodes, and server nodes.
+                                    1. The master node is responsible for model training, non-personalized item recommendation, configuration management, and membership management.
+                                    1. The server node is responsible for exposing the RESTful APIs and online real-time recommendations.
+                                    1. Worker nodes are responsible for offline recommendations for each user.
+
+                                    In addition, the administrator can perform system monitoring, data import and export, and system status checking via the dashboard on the master node.
+
+                                    <img width=520 src="assets/architecture.png"/>
+
+                                    ## Contributors
+
+                                    <a href="https://github.com/zhenghaoz/gorse/graphs/contributors">
+                                      <img src="https://contrib.rocks/image?repo=zhenghaoz/gorse" />
+                                      </a>
+
+                                      Any contribution is appreciated: report a bug, give advice or create a pull request. Read [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+                                      ## Acknowledgments
+
+                                      `gorse` is inspired by the following projects:
+
+                                      - [Guibing Guo's librec](https://github.com/guoguibing/librec)
+                                      - [Nicolas Hug's Surprise](https://github.com/NicolasHug/Surprise)
+                                      - [Golang Samples's gopher-vector](https://github.com/golang-samples/gopher-vector)