From 7ef986e062f93ea671d9d26c336653a7f6cb8eb2 Mon Sep 17 00:00:00 2001 From: Quoc-Tuan Truong Date: Tue, 3 Dec 2019 15:46:59 +0800 Subject: [PATCH] Fix documentation list displaying issue (#275) --- cornac/models/ncf/recom_gmf.py | 3 ++- cornac/models/ncf/recom_mlp.py | 3 ++- cornac/models/ncf/recom_neumf.py | 3 ++- docs/source/models.rst | 4 ++-- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/cornac/models/ncf/recom_gmf.py b/cornac/models/ncf/recom_gmf.py index 93c64d591..7967d5ded 100644 --- 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 index 674b16178..9f68c7532 100644 --- 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 index 140c0fe1b..c1fc7d60a 100644 --- 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 index bbe6e4277..5950a2f41 100644 --- 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: