From ca3b8118e185ffd8226062b0d8b9e8331a74ab21 Mon Sep 17 00:00:00 2001
From: jeffinsam <jeffinsam@karunya.edu.in>
Date: Mon, 4 Nov 2019 20:49:22 +0530
Subject: [PATCH] pointing to ensmallend docs for callbacks

---
 src/mlpack/methods/ann/ffn.hpp                              | 6 ++++--
 src/mlpack/methods/ann/gan/gan.hpp                          | 3 ++-
 src/mlpack/methods/ann/rnn.hpp                              | 6 ++++--
 .../methods/logistic_regression/logistic_regression.hpp     | 6 ++++--
 4 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/src/mlpack/methods/ann/ffn.hpp b/src/mlpack/methods/ann/ffn.hpp
index 8bb2f35c7e..3eea1f2a15 100644
--- a/src/mlpack/methods/ann/ffn.hpp
+++ b/src/mlpack/methods/ann/ffn.hpp
@@ -98,7 +98,8 @@ class FFN
    * @param predictors Input training variables.
    * @param responses Outputs results from input training variables.
    * @param optimizer Instantiated optimizer used to train the model.
-   * @param callbacks Callback Functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error).
    */
   template<typename OptimizerType, typename... CallbackTypes>
@@ -123,7 +124,8 @@ class FFN
    * @param predictors Input training variables.
    * @tparam CallbackTypes Types of Callback Functions.
    * @param responses Outputs results from input training variables.
-   * @param callbacks Callback Functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error).
    */
   template<typename OptimizerType = ens::RMSProp, typename... CallbackTypes>
diff --git a/src/mlpack/methods/ann/gan/gan.hpp b/src/mlpack/methods/ann/gan/gan.hpp
index ef24972a18..e90396c98b 100644
--- a/src/mlpack/methods/ann/gan/gan.hpp
+++ b/src/mlpack/methods/ann/gan/gan.hpp
@@ -116,7 +116,8 @@ class GAN
    * @tparam CallbackTypes Types of Callback functions.
    * @param trainData The data points of real distribution.
    * @param optimizer Instantiated optimizer used to train the model. 
-   * @param callbacks Callback functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error).
    */
   template<typename OptimizerType, typename... CallbackTypes>
diff --git a/src/mlpack/methods/ann/rnn.hpp b/src/mlpack/methods/ann/rnn.hpp
index 2d08eb3ffc..c94d647518 100644
--- a/src/mlpack/methods/ann/rnn.hpp
+++ b/src/mlpack/methods/ann/rnn.hpp
@@ -95,7 +95,8 @@ class RNN
    * @param predictors Input training variables.
    * @param responses Outputs results from input training variables.
    * @param optimizer Instantiated optimizer used to train the model.
-   * @param callbacks Callback functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error).
    */
   template<typename OptimizerType, typename... CallbackTypes>
@@ -127,7 +128,8 @@ class RNN
    * @tparam CallbackTypes Types of Callback Functions.
    * @param predictors Input training variables.
    * @param responses Outputs results from input training variables.
-   * @param callbacks Callback functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error).
    */
   template<typename OptimizerType = ens::StandardSGD, typename... CallbackTypes>
diff --git a/src/mlpack/methods/logistic_regression/logistic_regression.hpp b/src/mlpack/methods/logistic_regression/logistic_regression.hpp
index b948752fe4..d155713b21 100644
--- a/src/mlpack/methods/logistic_regression/logistic_regression.hpp
+++ b/src/mlpack/methods/logistic_regression/logistic_regression.hpp
@@ -126,7 +126,8 @@ class LogisticRegression
    * @tparam CallbackTypes Types of Callback Functions.
    * @param predictors Input training variables.
    * @param responses Outputs results from input training variables.
-   * @param callbacks Callback Functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error)
    */
   template<typename OptimizerType = ens::L_BFGS, typename... CallbackTypes>
@@ -151,7 +152,8 @@ class LogisticRegression
    * @param predictors Input training variables.
    * @param responses Outputs results from input training variables.
    * @param optimizer Instantiated optimizer with instantiated error function.
-   * @param callbacks Callback Functions.
+   * @param callbacks Callback function for ensmallen optimizer `OptimizerType`.
+   *      See https://www.ensmallen.org/docs.html#callback-documentation.
    * @return The final objective of the trained model (NaN or Inf on error)
    */
   template<typename OptimizerType, typename... CallbackTypes>