[mlpack-git] master: Better documentation. (d86bccc)

gitdub at mlpack.org gitdub at mlpack.org
Fri Feb 12 15:49:54 EST 2016


Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/ec35c2d4bc564e1431abf7c9aa14737c1d40328b...46e0a233c29ae638ba60eb224826168516c0ec4e

>---------------------------------------------------------------

commit d86bccc2315eb7658e740260bc823c195be2d4dc
Author: Ryan Curtin <ryan at ratml.org>
Date:   Fri Feb 12 12:49:54 2016 -0800

    Better documentation.


>---------------------------------------------------------------

d86bccc2315eb7658e740260bc823c195be2d4dc
 src/mlpack/core/optimizers/sgd/sgd.hpp | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/mlpack/core/optimizers/sgd/sgd.hpp b/src/mlpack/core/optimizers/sgd/sgd.hpp
index 5e1705a..5572f10 100644
--- a/src/mlpack/core/optimizers/sgd/sgd.hpp
+++ b/src/mlpack/core/optimizers/sgd/sgd.hpp
@@ -72,7 +72,12 @@ class SGD
 {
  public:
   /**
-   * Construct the SGD optimizer with the given function and parameters.
+   * Construct the SGD optimizer with the given function and parameters.  The
+   * defaults here are not necessarily good for the given problem, so it is
+   * suggested that the values used be tailored to the task at hand.  The
+   * maximum number of iterations refers to the maximum number of points that
+   * are processed (i.e., one iteration equals one point; one iteration does not
+   * equal one pass over the dataset).
    *
    * @param function Function to be optimized (minimized).
    * @param stepSize Step size for each iteration.




More information about the mlpack-git mailing list