[Doc] Add SIM (#401)

massquantity · Nov 11, 2023 · c704672 · c704672
1 parent f5c84f8
commit c704672
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -266,6 +266,7 @@ One can also use the library in a docker container without installing dependenci
 |      PinSage      |                       feat                        |    DGL, PyTorch     |                                                   |               :heavy_check_mark:               |                 :heavy_check_mark:                 | [Graph Convolutional Neural Networks for Web-Scale](https://arxiv.org/abs/1806.01973)                                                                                                                                                                                                                                                                            |
 |     TwoTower      |                       feat                        |     TensorFlow1     |                                                   |                                                |                 :heavy_check_mark:                 | 1. [Sampling-Bias-Corrected Neural Modeling for Large Corpus Item](https://storage.googleapis.com/pub-tools-public-publication-data/pdf/6c8a86c981a62b0126a11896b7f6ae0dae4c3566.pdf)  <br>2. [Self-supervised Learning for Large-scale Item](https://arxiv.org/pdf/2007.12865.pdf)                                                                              |
 |    Transformer    |                       feat                        |     TensorFlow1     |                :heavy_check_mark:                 |                                                |                                                    | 1. [BST](https://arxiv.org/pdf/1905.06874.pdf)  <br>2. [Transformers4Rec](https://dl.acm.org/doi/10.1145/3460231.3474255) <br>3. [RMSNorm](https://arxiv.org/pdf/1910.07467.pdf)                                                                                                                                                                                 |
+|        SIM        |                       feat                        |     TensorFlow1     |                :heavy_check_mark:                 |                                                |                                                    | [SIM](https://arxiv.org/pdf/2006.05639.pdf)                                                                                                                                                                                                                                                                                                                      |
 
 > <sup id="fn1">[1] **Category**: `pure` means collaborative-filtering algorithms which only use behavior data,  `feat` means other side-features can be included. <a href="#ref1" title="Jump back to footnote 1 in the text.">↩</a></sup>
 > 

diff --git a/docs/source/api/algorithms/index.rst b/docs/source/api/algorithms/index.rst
@@ -32,3 +32,4 @@ Algorithms
    pinsage_dgl
    two_tower
    transformer
+   sim
diff --git a/docs/source/api/algorithms/sim.rst b/docs/source/api/algorithms/sim.rst
@@ -0,0 +1,7 @@
+SIM
+---
+
+.. autoclass:: libreco.algorithms.SIM
+   :members:
+   :inherited-members:
+   :show-inheritance: