Fix documentation list displaying issue (PreferredAI#275)

Aznoryusof · Dec 3, 2019 · 7ef986e · 7ef986e
1 parent ad0597a
commit 7ef986e
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/cornac/models/ncf/recom_gmf.py b/cornac/models/ncf/recom_gmf.py
@@ -46,7 +46,8 @@ class GMF(Recommender):
         Specify an optimizer: adagrad, adam, rmsprop, sgd
 
     early_stopping: {min_delta: float, patience: int}, optional, default: None
-        If `None`, no early stopping. Meaning of the arguments: \
+        If `None`, no early stopping. Meaning of the arguments: 
+        
          - `min_delta`: the minimum increase in monitored value on validation set to be considered as improvement, \
            i.e. an increment of less than min_delta will count as no improvement.
          - `patience`: number of epochs with no improvement after which training should be stopped.

diff --git a/cornac/models/ncf/recom_mlp.py b/cornac/models/ncf/recom_mlp.py
@@ -52,7 +52,8 @@ class MLP(Recommender):
         Specify an optimizer: adagrad, adam, rmsprop, sgd
 
     early_stopping: {min_delta: float, patience: int}, optional, default: None
-        If `None`, no early stopping. Meaning of the arguments: \
+        If `None`, no early stopping. Meaning of the arguments:
+        
          - `min_delta`: the minimum increase in monitored value on validation set to be considered as improvement, \
            i.e. an increment of less than min_delta will count as no improvement.
          - `patience`: number of epochs with no improvement after which training should be stopped.

diff --git a/cornac/models/ncf/recom_neumf.py b/cornac/models/ncf/recom_neumf.py
@@ -58,7 +58,8 @@ class NeuMF(Recommender):
         Specify an optimizer: adagrad, adam, rmsprop, sgd
 
     early_stopping: {min_delta: float, patience: int}, optional, default: None
-        If `None`, no early stopping. Meaning of the arguments: \
+        If `None`, no early stopping. Meaning of the arguments: 
+        
          - `min_delta`: the minimum increase in monitored value on validation set to be considered as improvement, \
            i.e. an increment of less than min_delta will count as no improvement.
          - `patience`: number of epochs with no improvement after which training should be stopped.

diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -35,7 +35,7 @@ Collaborative Variational Autoencoder (CVAE)
 .. automodule:: cornac.models.cvae.recom_cvae
    :members:
 
-Generalized Matrix Factorization (NeuMF)
+Generalized Matrix Factorization (GMF)
 -----------------------------------------
 .. automodule:: cornac.models.ncf.recom_gmf
    :members:
@@ -55,7 +55,7 @@ Multi-Layer Perceptron (MLP)
 .. automodule:: cornac.models.ncf.recom_mlp
    :members:
 
-Neural Matrix Factorization (NeuMF)
+Neural Matrix Factorization (NeuMF/NCF)
 ----------------------------------------------
 .. automodule:: cornac.models.ncf.recom_neumf
    :members: