DOC: update documents.

docs/source/index.rst

@@ -38,7 +38,7 @@ RecBole v0.2.0
    :maxdepth: 1
    :caption: API REFERENCE:
 
-   recbole/recbole.config
+   recbole/recbole.config.configurator
    recbole/recbole.data
    recbole/recbole.evaluator
    recbole/recbole.model

docs/source/recbole/recbole.data.dataloader.rst

@@ -5,9 +5,6 @@ recbole.data.dataloader
    :maxdepth: 4
 
    recbole.data.dataloader.abstract_dataloader
-   recbole.data.dataloader.context_dataloader
    recbole.data.dataloader.general_dataloader
    recbole.data.dataloader.knowledge_dataloader
-   recbole.data.dataloader.neg_sample_mixin
-   recbole.data.dataloader.sequential_dataloader
    recbole.data.dataloader.user_dataloader

docs/source/recbole/recbole.data.dataset.rst

@@ -9,4 +9,3 @@ recbole.data.dataset
    recbole.data.dataset.kg_dataset
    recbole.data.dataset.kg_seq_dataset
    recbole.data.dataset.sequential_dataset
-   recbole.data.dataset.social_dataset

docs/source/recbole/recbole.evaluator.proxy_evaluator.rst → docs/source/recbole/recbole.evaluator.base_metric.rst

@@ -1,4 +1,4 @@
-.. automodule:: recbole.evaluator.proxy_evaluator
+.. automodule:: recbole.evaluator.base_metric
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/recbole/recbole.config.eval_setting.rst → docs/source/recbole/recbole.evaluator.collector.rst

@@ -1,4 +1,4 @@
-.. automodule:: recbole.config.eval_setting
+.. automodule:: recbole.evaluator.collector
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/recbole/recbole.evaluator.evaluators.rst → docs/source/recbole/recbole.evaluator.evaluator.rst

@@ -1,4 +1,4 @@
-.. automodule:: recbole.evaluator.evaluators
+.. automodule:: recbole.evaluator.evaluator
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/recbole/recbole.data.dataset.social_dataset.rst → docs/source/recbole/recbole.evaluator.register.rst

@@ -1,4 +1,4 @@
-.. automodule:: recbole.data.dataset.social_dataset
+.. automodule:: recbole.evaluator.register
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/recbole/recbole.evaluator.rst

@@ -4,8 +4,9 @@ recbole.evaluator
 .. toctree::
    :maxdepth: 4
 
-   recbole.evaluator.abstract_evaluator
-   recbole.evaluator.evaluators
+   recbole.evaluator.base_metric
+   recbole.evaluator.collector
+   recbole.evaluator.evaluator
    recbole.evaluator.metrics
-   recbole.evaluator.proxy_evaluator
+   recbole.evaluator.register
    recbole.evaluator.utils

docs/source/user_guide/model_intro.rst

@@ -9,6 +9,7 @@ General Recommendation
 In the class of general recommendation, the interaction of users and items(.inter file) is the only data
 that can be used by model. Usually, the models are trained on implicit feedback data and evaluated under the
 task of top-n recommendation. All the collaborative filter(CF) based models are classified in this class.
+
 .. toctree::
    :maxdepth: 1
 
@@ -72,6 +73,7 @@ Sequential Recommendation
 The task of sequential recommendation(next-item recommendation) is the same as general recommendation which sort a list of items according
 to preference. While the history interactions are organized in sequences and the model tend to characterize
 the sequential data. The models of session-based recommendation are also included in this class.
+
 .. toctree::
    :maxdepth: 1
 

tests/model/test_model_auto.py

@@ -149,38 +149,38 @@ def test_ease(self):
     def test_MultiDAE(self):
         config_dict = {
             'model': 'MultiDAE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_MultiVAE(self):
         config_dict = {
             'model': 'MultiVAE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_enmf(self):
         config_dict = {
             'model': 'ENMF',
-            'neg_sampling': None ,
+            'neg_sampling': None,
         }
         quick_test(config_dict)
- 
+
     def test_MacridVAE(self):
         config_dict = {
             'model': 'MacridVAE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_CDAE(self):
         config_dict = {
             'model': 'CDAE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
-        
+
     def test_NNCF(self):
         config_dict = {
             'model': 'NNCF',
@@ -190,7 +190,7 @@ def test_NNCF(self):
     def test_RecVAE(self):
         config_dict = {
             'model': 'RecVAE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -378,7 +378,7 @@ def test_fpmc(self):
     def test_gru4rec(self):
         config_dict = {
             'model': 'GRU4Rec',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -392,7 +392,7 @@ def test_gru4rec_with_BPR_loss(self):
     def test_narm(self):
         config_dict = {
             'model': 'NARM',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -406,7 +406,7 @@ def test_narm_with_BPR_loss(self):
     def test_stamp(self):
         config_dict = {
             'model': 'STAMP',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -422,7 +422,7 @@ def test_caser(self):
             'model': 'Caser',
             'MAX_ITEM_LIST_LENGTH': 10,
             'reproducibility': False,
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -439,7 +439,7 @@ def test_nextitnet(self):
         config_dict = {
             'model': 'NextItNet',
             'reproducibility': False,
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -460,7 +460,7 @@ def test_transrec(self):
     def test_sasrec(self):
         config_dict = {
             'model': 'SASRec',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -484,7 +484,7 @@ def test_srgnn(self):
         config_dict = {
             'model': 'SRGNN',
             'MAX_ITEM_LIST_LENGTH': 3,
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -500,7 +500,7 @@ def test_gcsan(self):
         config_dict = {
             'model': 'GCSAN',
             'MAX_ITEM_LIST_LENGTH': 3,
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -516,53 +516,53 @@ def test_gcsan_with_BPR_loss_and_tanh(self):
     def test_gru4recf(self):
         config_dict = {
             'model': 'GRU4RecF',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_gru4recf_with_max_pooling(self):
         config_dict = {
             'model': 'GRU4RecF',
             'pooling_mode': 'max',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_gru4recf_with_sum_pooling(self):
         config_dict = {
             'model': 'GRU4RecF',
             'pooling_mode': 'sum',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_sasrecf(self):
         config_dict = {
             'model': 'SASRecF',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_sasrecf_with_max_pooling(self):
         config_dict = {
             'model': 'SASRecF',
             'pooling_mode': 'max',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_sasrecf_with_sum_pooling(self):
         config_dict = {
             'model': 'SASRecF',
             'pooling_mode': 'sum',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_hrm(self):
         config_dict = {
             'model': 'HRM',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -576,7 +576,7 @@ def test_hrm_with_BPR_loss(self):
     def test_npe(self):
         config_dict = {
             'model': 'NPE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -590,7 +590,7 @@ def test_npe_with_BPR_loss(self):
     def test_shan(self):
         config_dict = {
             'model': 'SHAN',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -611,14 +611,14 @@ def test_hgn_with_CE_loss(self):
         config_dict = {
             'model': 'HGN',
             'loss_type': 'CE',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_fossil(self):
         config_dict = {
             'model': 'FOSSIL',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
@@ -631,30 +631,30 @@ def test_repeat_net(self):
     def test_fdsa(self):
         config_dict = {
             'model': 'FDSA',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_fdsa_with_max_pooling(self):
         config_dict = {
             'model': 'FDSA',
             'pooling_mode': 'max',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_fdsa_with_sum_pooling(self):
         config_dict = {
             'model': 'FDSA',
             'pooling_mode': 'sum',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         quick_test(config_dict)
 
     def test_bert4rec(self):
         config_dict = {
             'model': 'BERT4Rec',
-            'neg_sampling': None 
+            'neg_sampling': None
         }
         objective_function(config_dict=config_dict,
                            config_file_list=config_file_list, saved=False)
@@ -808,6 +808,5 @@ def test_kgnnls_with_concat(self):
         quick_test(config_dict)
 
 
-
 if __name__ == '__main__':
     unittest.main()