[mlpack-git] master: Clarify or fix documentation for API changes. (38a1905)
gitdub at big.cc.gt.atl.ga.us
gitdub at big.cc.gt.atl.ga.us
Mon Nov 30 17:24:17 EST 2015
Repository : https://github.com/mlpack/mlpack
On branch : master
Link : https://github.com/mlpack/mlpack/compare/10b9d45b806a3e879b0564d78ccb183ebc7051ba...31c557d9cc7e4da57fd8a246085c19e076d12271
>---------------------------------------------------------------
commit 38a1905cda03c1dcad400a7d354d5295c322010e
Author: Ryan Curtin <ryan at ratml.org>
Date: Sat Nov 21 01:41:08 2015 +0000
Clarify or fix documentation for API changes.
>---------------------------------------------------------------
38a1905cda03c1dcad400a7d354d5295c322010e
src/mlpack/methods/decision_stump/decision_stump.hpp | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/src/mlpack/methods/decision_stump/decision_stump.hpp b/src/mlpack/methods/decision_stump/decision_stump.hpp
index a9cc605..ccfe678 100644
--- a/src/mlpack/methods/decision_stump/decision_stump.hpp
+++ b/src/mlpack/methods/decision_stump/decision_stump.hpp
@@ -44,8 +44,8 @@ class DecisionStump
const size_t bucketSize);
/**
- * Alternate constructor which copies parameters bucketSize and numClass from
- * an already initiated decision stump, other. It appropriately sets the
+ * Alternate constructor which copies the parameters bucketSize and classes
+ * from an already initiated decision stump, other. It appropriately sets the
* weight vector.
*
* @param other The other initiated Decision Stump object from
@@ -129,7 +129,7 @@ class DecisionStump
*
* @param attribute A row from the training data, which might be a
* candidate for the splitting attribute.
- * @param UseWeights Whether we need to run a weighted Decision Stump.
+ * @tparam UseWeights Whether we need to run a weighted Decision Stump.
*/
template<bool UseWeights>
double SetupSplitAttribute(const arma::rowvec& attribute,
@@ -140,7 +140,7 @@ class DecisionStump
* After having decided the attribute on which to split, train on that
* attribute.
*
- * @param attribute attribute is the attribute decided by the constructor
+ * @tparam attribute attribute is the attribute decided by the constructor
* on which we now train the decision stump.
*/
void TrainOnAtt(const arma::rowvec& attribute,
@@ -155,8 +155,8 @@ class DecisionStump
/**
* Count the most frequently occurring element in subCols.
*
- * @param subCols The vector in which to find the most frequently
- * occurring element.
+ * @param subCols The vector in which to find the most frequently occurring
+ * element.
*/
template<typename VecType>
double CountMostFreq(const VecType& subCols);
@@ -175,6 +175,8 @@ class DecisionStump
* @param labels Corresponding labels of the attribute.
* @param classes Number of classes.
* @param weights Weights for this set of labels.
+ * @tparam UseWeights If true, the weights in the weight vector will be used
+ * (otherwise they are ignored).
*/
template<bool UseWeights, typename VecType, typename WeightVecType>
double CalculateEntropy(const VecType& labels,
@@ -185,7 +187,9 @@ class DecisionStump
*
* @param data Dataset to train on.
* @param labels Labels for dataset.
- * @param UseWeights Whether we need to run a weighted Decision Stump.
+ * @param weights Weights for this set of labels.
+ * @tparam UseWeights If true, the weights in the weight vector will be used
+ * (otherwise they are ignored).
*/
template<bool UseWeights>
void Train(const MatType& data,
More information about the mlpack-git
mailing list