Refact model rst

Signed-off-by: miguelgfierro <[email protected]>

docs/models.rst

@@ -5,267 +5,269 @@ Recommender algorithms module
 
 Recommender system algorithms and utilities.
 
-Cornac
+Cornac utilities
 ******************************
-
 .. automodule:: recommenders.models.cornac.cornac_utils
     :members:
 
-DeepRec
-******************************
 
+DeepRec utilities
+******************************
 Base model
-==================
+===========
 .. automodule:: recommenders.models.deeprec.models.base_model
     :members:
 
-DKN
+Sequential base model
 ==================
+.. automodule:: recommenders.models.deeprec.models.sequential.sequential_base_model
+    :members:
+
+Iterators
+===========
+.. automodule:: recommenders.models.deeprec.io.iterator
+    :members:
+.. automodule:: recommenders.models.deeprec.io.dkn_iterator
+    :members:
+.. automodule:: recommenders.models.deeprec.io.dkn_item2item_iterator
+    :members:
+.. automodule:: recommenders.models.deeprec.io.nextitnet_iterator
+    :members:
+.. automodule:: recommenders.models.deeprec.io.sequential_iterator
+    :members:
+
+Data processing utilities
+===========================
+.. automodule:: recommenders.models.deeprec.DataModel.ImplicitCF
+    :members:
+
+Utilities
+============
+.. automodule:: recommenders.models.deeprec.deeprec_utils
+    :members:
+
+
+DKN
+******************************
 .. automodule:: recommenders.models.deeprec.models.dkn
     :members:
 
+
 DKN item-to-item
-==================
+******************************
 .. automodule:: recommenders.models.deeprec.models.dkn_item2item
     :members:
 
+
 xDeepFM
-==============
+******************************
 .. automodule:: recommenders.models.deeprec.models.xDeepFM
     :members:
 
+
 LightGCN
-==================
+******************************
 .. automodule:: recommenders.models.deeprec.models.graphrec.lightgcn
     :members:
 
-Sequential models
-==================
-
-Sequential base model
----------------------------
-.. automodule:: recommenders.models.deeprec.models.sequential.sequential_base_model
-    :members:
 
 A2SVD
--------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.asvd
     :members:
 
+
 Caser
-----------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.caser
     :members:
 
+
 GRU
---------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.gru
     :members:
 
+
 NextItNet
---------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.nextitnet
     :members:
 
+
 RNN Cells
-------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.rnn_cell_implement
     :members:
 
+
 SUM
--------------------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.sum
     :members:
-
 .. automodule:: recommenders.models.deeprec.models.sequential.sum_cells
     :members:
 
+
 SLIRec
--------------
+******************************
 .. automodule:: recommenders.models.deeprec.models.sequential.sli_rec
     :members:
 
-Iterators
-===========
-
-.. automodule:: recommenders.models.deeprec.io.iterator
-    :members:
 
-.. automodule:: recommenders.models.deeprec.io.dkn_iterator
-    :members:
-
-.. automodule:: recommenders.models.deeprec.io.dkn_item2item_iterator
-    :members:
-
-.. automodule:: recommenders.models.deeprec.io.nextitnet_iterator
-    :members:
-
-.. automodule:: recommenders.models.deeprec.io.sequential_iterator
-    :members:
-
-Data processing utilities
-===========================
-
-.. automodule:: recommenders.models.deeprec.DataModel.ImplicitCF
-    :members:
-
-Utilities
-============
-
-.. automodule:: recommenders.models.deeprec.deeprec_utils
-    :members:
-
-FastAI
+FastAI utilities
 ******************************
-
 .. automodule:: recommenders.models.fastai.fastai_utils
     :members:
 
+
 GeoIMC
 ******************************
-
 .. automodule:: recommenders.models.geoimc.geoimc_algorithm
     :members:
-
 .. automodule:: recommenders.models.geoimc.geoimc_data
     :members:
-
 .. automodule:: recommenders.models.geoimc.geoimc_predict
     :members:
-
 .. automodule:: recommenders.models.geoimc.geoimc_utils
     :members:
 
-LightFM
-******************************
 
+LightFM utilities
+******************************
 .. automodule:: recommenders.models.lightfm.lightfm_utils
     :members:
 
-LightGBM
-******************************
 
+LightGBM utilities
+******************************
 .. automodule:: recommenders.models.lightgbm.lightgbm_utils
     :members:
 
+
 NCF
 ******************************
-
 .. automodule:: recommenders.models.ncf.dataset
     :members:
-
 .. automodule:: recommenders.models.ncf.ncf_singlenode
     :members:
 
-NewsRec
+
+NewsRec utilities
 ******************************
+Base model
+===========
+.. automodule:: recommenders.models.newsrec.models.base_model
+    :members:
 
+Iterators
+===========
 .. automodule:: recommenders.models.newsrec.io.mind_all_iterator
     :members:
-
 .. automodule:: recommenders.models.newsrec.io.mind_iterator
     :members:
 
-.. automodule:: recommenders.models.newsrec.models.base_model
-    :members:
-
+Utilities
+============
 .. automodule:: recommenders.models.newsrec.models.layers
     :members:
+.. automodule:: recommenders.models.newsrec.newsrec_utils
+    :members:
 
+
+LSTUR
+******************************
 .. automodule:: recommenders.models.newsrec.models.lstur
     :members:
 
+
+NAML
+******************************
 .. automodule:: recommenders.models.newsrec.models.naml
     :members:
 
+
+NPA
+******************************
 .. automodule:: recommenders.models.newsrec.models.npa
     :members:
 
+
+NRMS
+******************************
 .. automodule:: recommenders.models.newsrec.models.nrms
     :members:
 
-.. automodule:: recommenders.models.newsrec.newsrec_utils
-    :members:
 
 RBM
 ******************************
-
 .. automodule:: recommenders.models.rbm.rbm
     :members:
 
 
 RLRMC
 ******************************
-
-.. automodule:: recommenders.models.rlrmc.RLRMCalgorithm
-    :members:
-
 .. automodule:: recommenders.models.rlrmc.RLRMCdataset
     :members:
-
+.. automodule:: recommenders.models.rlrmc.RLRMCalgorithm
+    :members:
 .. automodule:: recommenders.models.rlrmc.conjugate_gradient_ms
     :members:
 
 
 SAR
 ******************************
-
 .. automodule:: recommenders.models.sar.sar_singlenode
     :members:
 
+
 SASRec 
 ******************************
-
 .. automodule:: recommenders.models.sasrec.model
     :members:
-
 .. automodule:: recommenders.models.sasrec.sampler
     :members:
-
 .. automodule:: recommenders.models.sasrec.util
     :members:
 
 
 SSE-PT 
 ******************************
-
 .. automodule:: recommenders.models.sasrec.ssept
     :members:
 
 
-Surprise
+Surprise utilities
 ******************************
-
 .. automodule:: recommenders.models.surprise.surprise_utils
     :members:
 
 
-TF-IDF
+TF-IDF utilities
 ******************************
-
 .. automodule:: recommenders.models.tfidf.tfidf_utils
     :members:
 
 
-VAE
+Standard VAE
 ******************************
-
-.. automodule:: recommenders.models.vae.multinomial_vae
-    :members:
-
 .. automodule:: recommenders.models.vae.standard_vae
     :members:
 
 
-Vowpal Wabbit
+Multinomial VAE
 ******************************
+.. automodule:: recommenders.models.vae.multinomial_vae
+    :members:
+
 
+Vowpal Wabbit utilities
+******************************
 .. automodule:: recommenders.models.vowpal_wabbit.vw
     :members:
 
 
 Wide & Deep
 ******************************
-
 .. automodule:: recommenders.models.wide_deep.wide_deep_utils
     :members: