Merge pull request #2076 from jeffin143/docsfix

Pointing to ensmallend docs for callbacks docs.

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>

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>

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>

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>