[mlpack-svn] r13785 - mlpack/trunk/src/mlpack/core/optimizers/lbfgs
fastlab-svn at coffeetalk-1.cc.gatech.edu
fastlab-svn at coffeetalk-1.cc.gatech.edu
Tue Oct 30 13:40:37 EDT 2012
Author: rcurtin
Date: 2012-10-30 13:40:37 -0400 (Tue, 30 Oct 2012)
New Revision: 13785
Modified:
mlpack/trunk/src/mlpack/core/optimizers/lbfgs/lbfgs.hpp
Log:
Clarify documentation. L_BFGS is a minimizer.
Modified: mlpack/trunk/src/mlpack/core/optimizers/lbfgs/lbfgs.hpp
===================================================================
--- mlpack/trunk/src/mlpack/core/optimizers/lbfgs/lbfgs.hpp 2012-10-30 17:12:23 UTC (rev 13784)
+++ mlpack/trunk/src/mlpack/core/optimizers/lbfgs/lbfgs.hpp 2012-10-30 17:40:37 UTC (rev 13785)
@@ -15,10 +15,10 @@
/**
* The generic L-BFGS optimizer, which uses a back-tracking line search
- * algorithm. The parameters for the algorithm (number of memory points,
- * maximum step size, and so forth) are all configurable via either the
- * constructor or standalone modifier functions. A function which can be
- * optimized by this class must implement the following methods:
+ * algorithm to minimize a function. The parameters for the algorithm (number
+ * of memory points, maximum step size, and so forth) are all configurable via
+ * either the constructor or standalone modifier functions. A function which
+ * can be optimized by this class must implement the following methods:
*
* - a default constructor
* - double Evaluate(const arma::mat& coordinates);
@@ -69,11 +69,11 @@
/**
* Use L-BFGS to optimize the given function, starting at the given iterate
- * point. The maximum number of iterations is set in the constructor (or with
- * MaxIterations()). Alternately, another overload is provided which takes a
- * maximum number of iterations as a parameter. The given starting point will
- * be modified to store the finishing point of the algorithm, and the final
- * objective value is returned.
+ * point and finding the minimum. The maximum number of iterations is set in
+ * the constructor (or with MaxIterations()). Alternately, another overload
+ * is provided which takes a maximum number of iterations as a parameter. The
+ * given starting point will be modified to store the finishing point of the
+ * algorithm, and the final objective value is returned.
*
* @param iterate Starting point (will be modified).
* @return Objective value of the final point.
@@ -81,10 +81,10 @@
double Optimize(arma::mat& iterate);
/**
- * Use L-BFGS to optimize the given function, starting at the given iterate
- * point, and performing no more than the given maximum number of iterations
- * (the class variable maxIterations is ignored for this run, but not
- * modified). The given starting point will be modified to store the
+ * Use L-BFGS to optimize (minimize) the given function, starting at the given
+ * iterate point, and performing no more than the given maximum number of
+ * iterations (the class variable maxIterations is ignored for this run, but
+ * not modified). The given starting point will be modified to store the
* finishing point of the algorithm, and the final objective value is
* returned.
*
More information about the mlpack-svn
mailing list