[mlpack-git] master: * added AMF tutorial to index page * minor changes to doc files (3b2888b)
gitdub at big.cc.gt.atl.ga.us
gitdub at big.cc.gt.atl.ga.us
Thu Mar 5 21:59:22 EST 2015
Repository : https://github.com/mlpack/mlpack
On branch : master
Link : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40
>---------------------------------------------------------------
commit 3b2888be81e1739383ed9da8f8669c2725e767c9
Author: sumedhghaisas <sumedhghaisas at gmail.com>
Date: Thu Aug 21 17:56:01 2014 +0000
* added AMF tutorial to index page
* minor changes to doc files
>---------------------------------------------------------------
3b2888be81e1739383ed9da8f8669c2725e767c9
src/mlpack/core.hpp | 1 +
src/mlpack/core/util/prefixedoutstream.hpp | 2 ++
src/mlpack/methods/linear_regression/linear_regression.hpp | 3 ++-
src/mlpack/methods/pca/pca.hpp | 2 +-
4 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/mlpack/core.hpp b/src/mlpack/core.hpp
index 5a63f12..ce001f5 100644
--- a/src/mlpack/core.hpp
+++ b/src/mlpack/core.hpp
@@ -73,6 +73,7 @@
* - @ref emst_tutorial
* - @ref kmtutorial
* - @ref fmkstutorial
+ * - @ref amftutorial
*
* @section methods Methods in MLPACK
*
diff --git a/src/mlpack/core/util/prefixedoutstream.hpp b/src/mlpack/core/util/prefixedoutstream.hpp
index 61f873a..49a6f53 100644
--- a/src/mlpack/core/util/prefixedoutstream.hpp
+++ b/src/mlpack/core/util/prefixedoutstream.hpp
@@ -56,6 +56,8 @@ class PrefixedOutStream
*
* @param destination ostream which receives output from this object.
* @param prefix The prefix to prepend to each line.
+ * @param ignoreInput if true the stream will not be printed
+ * @param fatal is true program will exit after printing a line
*/
PrefixedOutStream(std::ostream& destination,
const char* prefix,
diff --git a/src/mlpack/methods/linear_regression/linear_regression.hpp b/src/mlpack/methods/linear_regression/linear_regression.hpp
index f908ba8..265e290 100644
--- a/src/mlpack/methods/linear_regression/linear_regression.hpp
+++ b/src/mlpack/methods/linear_regression/linear_regression.hpp
@@ -25,6 +25,7 @@ class LinearRegression
*
* @param predictors X, matrix of data points to create B with.
* @param responses y, the measured data for each point in X
+ * @param lambda regularization constant
*/
LinearRegression(const arma::mat& predictors,
const arma::vec& responses,
@@ -71,7 +72,7 @@ class LinearRegression
*
* As this number decreases to 0, the linear regression fit is better.
*
- * @param predictors Matrix of predictors (X).
+ * @param points Matrix of predictors (X).
* @param responses Vector of responses (y).
*/
double ComputeError(const arma::mat& points,
diff --git a/src/mlpack/methods/pca/pca.hpp b/src/mlpack/methods/pca/pca.hpp
index df6bce6..41a2fe2 100644
--- a/src/mlpack/methods/pca/pca.hpp
+++ b/src/mlpack/methods/pca/pca.hpp
@@ -51,7 +51,7 @@ class PCA
*
* @param data Data matrix.
* @param transformedData Matrix to store results of PCA in.
- * @param eigval Vector to put eigenvalues into.
+ * @param eigVal Vector to put eigenvalues into.
*/
void Apply(const arma::mat& data,
arma::mat& transformedData,
More information about the mlpack-git
mailing list