[mlpack-git] master: Better program documentation. (7d0b607)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/09cbc6e13aa3cb8a7c4ea6d2e1612977a40c6be7...be72510a765362f86782a8892f0e979aaa4a9f62

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

commit 7d0b6073bdd07c3d913f556a84bfd3c2ded211f6
Author: ryan <ryan at ratml.org>
Date:   Mon Dec 21 12:51:42 2015 -0500

    Better program documentation.


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

7d0b6073bdd07c3d913f556a84bfd3c2ded211f6
 src/mlpack/methods/naive_bayes/nbc_main.cpp | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/mlpack/methods/naive_bayes/nbc_main.cpp b/src/mlpack/methods/naive_bayes/nbc_main.cpp
index 0b14fba..3565a5b 100644
--- a/src/mlpack/methods/naive_bayes/nbc_main.cpp
+++ b/src/mlpack/methods/naive_bayes/nbc_main.cpp
@@ -13,16 +13,23 @@
 
 PROGRAM_INFO("Parametric Naive Bayes Classifier",
     "This program trains the Naive Bayes classifier on the given labeled "
-    "training set and then uses the trained classifier to classify the points "
-    "in the given test set."
+    "training set, or loads a model from the given model file, and then may use"
+    " that trained model to classify the points in a given test set."
     "\n\n"
     "Labels are expected to be the last row of the training set (--train_file),"
     " but labels can also be passed in separately as their own file "
-    "(--labels_file)."
+    "(--labels_file).  If training is not desired, a pre-existing model can be "
+    "loaded with the --input_model_file (-m) option."
     "\n\n"
     "The '--incremental_variance' option can be used to force the training to "
     "use an incremental algorithm for calculating variance.  This is slower, "
-    "but can help avoid loss of precision in some cases.");
+    "but can help avoid loss of precision in some cases."
+    "\n\n"
+    "If classifying a test set is desired, the test set should be in the file "
+    "specified with the --test_file (-T) option, and the classifications will "
+    "be saved to the file specified with the --output_file (-o) option.  If "
+    "saving a trained model is desired, the --output_model_file (-M) option "
+    "should be given.");
 
 // Model loading/saving.
 PARAM_STRING("input_model_file", "File containing input Naive Bayes model.",