docs: add the tutorial for steamlens

gorse-io · Nov 24, 2019 · c083a2c · c083a2c
1 parent f92d06a
commit c083a2c
Show file tree

Hide file tree

Showing 6 changed files with 554 additions and 32 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -39,6 +39,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinxemoji.sphinxemoji'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
@@ -11,9 +11,13 @@ gorse is an offline recommender system backend based on collaborative filtering
 
 This project is aim to provide a high performance, easy-to-use, programming language irrelevant recommender micro-service based on collaborative filtering. We could build a simple recommender system on it, or set up a more sophisticated recommender system using candidates generated by it. It features:
 
-* Support data loading, data splitting, model training, model evaluation and model selection.
-* Provide the data import/export tool, model evaluation tool and RESTful recomender server.
-* Accelerate computations by SIMD instructions and multi-threading.
+- Implements 7 rating based recommenders and 4 ranking based recommenders.
+- Supports data loading, data splitting, model training, model evaluation and model selection.
+- Provides the data import/export tool, model evaluation tool and RESTful recomender server.
+- Accelerates computations by SIMD instructions and multi-threading.
+
+.. image:: https://img.sine-x.com/gorse-arch.png
+   :width: 500
 
 Contents
 ========

diff --git a/docs/introduction/model/index.rst b/docs/introduction/model/index.rst
@@ -4,33 +4,33 @@ Models
 
 There are all models implemented in *gorse*:
 
-+-------------------------+------------------------------+------------------+---------------------+
-| Model                   | Data                         | Task             | Multi-threading Fit |
-+-------------------------+----------+----------+--------+--------+---------+                     +
-|                         | explicit | implicit | weight | rating | ranking |                     |
-+=========================+==========+==========+========+========+=========+=====================+
-| BaseLine                | Yes      |          |        | Yes    | Yes     | No                  |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| NMF [#NMF]_             | Yes      |          |        | Yes    | Yes     | No                  |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| SVD                     | Yes      |          |        | Yes    | Yes     | No                  |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| SVD++ [#SVDPP]_         | Yes      |          |        | Yes    | Yes     | Yes                 |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| KNN [#KNN]_             | Yes      |          |        | Yes    | Yes     | Yes                 |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| CoClustering [#COC]_    | Yes      |          |        | Yes    | Yes     | Yes                 |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| SlopeOne [#SO]_         | Yes      |          |        | Yes    | Yes     | Yes                 |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| ItemPop                 | Yes      | Yes      |        |        | Yes     | No                  |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| KNN (Implicit) [#WRMF]_ | Yes      |          |        | Yes    | Yes     | Yes                 |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| WRMF [#WRMF]_           | Yes      | Yes      | Yes    |        | Yes     | No                  |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
-| BPR [#BPR]_             | Yes      | Yes      |        |        | Yes     | No                  |
-+-------------------------+----------+----------+--------+--------+---------+---------------------+
++-------------------------+--------------------------------------------------------------------+---------------------------------------------+----------------------+
+| Model                   | Data                                                               | Task                                        | Multi-threading Fit  |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+                      +
+|                         | explicit             | implicit             | weight               | rating               | ranking              |                      |
++=========================+======================+======================+======================+======================+======================+======================+
+| BaseLine                | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| |                      |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| NMF [#NMF]_             | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| |                      |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| SVD                     | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| |                      |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| SVD++ [#SVDPP]_         | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| KNN [#KNN]_             | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| CoClustering [#COC]_    | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| SlopeOne [#SO]_         | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| ItemPop                 | |:heavy_check_mark:| | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| |                      |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| KNN (Implicit) [#WRMF]_ | |:heavy_check_mark:| | |:heavy_check_mark:| |                      | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| WRMF [#WRMF]_           | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_check_mark:| |                      | |:heavy_check_mark:| |                      |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
+| BPR [#BPR]_             | |:heavy_check_mark:| | |:heavy_check_mark:| |                      |                      | |:heavy_check_mark:| |                      |
++-------------------------+----------------------+----------------------+----------------------+----------------------+----------------------+----------------------+
 
 Apparently, these models using implicit feedbacks are more general since explicit feedbacks could be converted to implicit feedbacks and item ranking could be done by rating prediction.
 

diff --git a/docs/quick_start/index.rst b/docs/quick_start/index.rst
@@ -5,4 +5,5 @@ Quick Start
 .. toctree::
    :caption: Table of Contents
    :maxdepth: 1
-
+
+   steamlens