[mlpack-git] master: Better documentation. (be72510)
gitdub at big.cc.gt.atl.ga.us
gitdub at big.cc.gt.atl.ga.us
Mon Dec 21 13:26:45 EST 2015
Repository : https://github.com/mlpack/mlpack
On branch : master
Link : https://github.com/mlpack/mlpack/compare/09cbc6e13aa3cb8a7c4ea6d2e1612977a40c6be7...be72510a765362f86782a8892f0e979aaa4a9f62
>---------------------------------------------------------------
commit be72510a765362f86782a8892f0e979aaa4a9f62
Author: ryan <ryan at ratml.org>
Date: Mon Dec 21 13:26:23 2015 -0500
Better documentation.
>---------------------------------------------------------------
be72510a765362f86782a8892f0e979aaa4a9f62
src/mlpack/methods/det/det_main.cpp | 23 +++++++++++++++--------
1 file changed, 15 insertions(+), 8 deletions(-)
diff --git a/src/mlpack/methods/det/det_main.cpp b/src/mlpack/methods/det/det_main.cpp
index e896b4c..87446d5 100644
--- a/src/mlpack/methods/det/det_main.cpp
+++ b/src/mlpack/methods/det/det_main.cpp
@@ -15,15 +15,22 @@ using namespace std;
PROGRAM_INFO("Density Estimation With Density Estimation Trees",
"This program performs a number of functions related to Density Estimation "
"Trees. The optimal Density Estimation Tree (DET) can be trained on a set "
- "of data (specified by --train_file) using cross-validation (with number of"
- " folds specified by --folds). In addition, the density of a set of test "
- "points (specified by --test_file) can be estimated, and the importance of "
- "each dimension can be computed. If class labels are given for the "
- "training points (with --labels_file), the class memberships of each leaf "
- "in the DET can be calculated."
+ "of data (specified by --training_file or -t) using cross-validation (with "
+ "number of folds specified by --folds). This trained density estimation "
+ "tree may then be saved to a model file with the --output_model_file (-M) "
+ "option."
"\n\n"
- "The created DET can be saved to a file, along with the density estimates "
- "for the test set and the variable importances.");
+ "The variable importances of each dimension may be saved with the "
+ "--vi_file (-i) option, and the density estimates on each training point "
+ "may be saved to the file specified with the --training_set_estimates_file "
+ "(-e) option."
+ "\n\n"
+ "This program also can provide density estimates for a set of test points, "
+ "specified in the --test_file (-T) file. The density estimation tree used "
+ "for this task will be the tree that was trained on the given training "
+ "points, or a tree stored in the file given with the --input_model_file "
+ "(-m) parameter. The density estimates for the test points may be saved "
+ "into the file specified with the --test_set_estimates_file (-E) option.");
// Input data files.
PARAM_STRING("training_file", "The data set on which to build a density "
More information about the mlpack-git
mailing list