[mlpack-git] master: Update documentation. (31b8022)

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

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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/6ab20afd8adaf9dcb86bc9a8ea98a24dd8b18743...eb41f4bc27b484c347acc006255104e2f8cc4eef

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

commit 31b8022de5282c70ce77b84d9cba983c2ca8c02f
Author: ryan <ryan at ratml.org>
Date:   Tue Dec 22 16:28:54 2015 -0500

    Update documentation.


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

31b8022de5282c70ce77b84d9cba983c2ca8c02f
 src/mlpack/methods/cf/cf_main.cpp | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/src/mlpack/methods/cf/cf_main.cpp b/src/mlpack/methods/cf/cf_main.cpp
index b22b72e..bc46876 100644
--- a/src/mlpack/methods/cf/cf_main.cpp
+++ b/src/mlpack/methods/cf/cf_main.cpp
@@ -21,9 +21,11 @@ using namespace std;
 // Document program.
 PROGRAM_INFO("Collaborating Filtering", "This program performs collaborative "
     "filtering (CF) on the given dataset. Given a list of user, item and "
-    "preferences (--input_file) the program will perform a matrix decomposition"
-    " and then can perform a series of actions related to collaborative "
-    "filtering."
+    "preferences (--training_file) the program will perform a matrix "
+    "decomposition and then can perform a series of actions related to "
+    "collaborative filtering.  Alternately, the program can load an existing "
+    "saved CF model with the --input_model_file (-m) option and then use that "
+    "model to provide recommendations or predict values."
     "\n\n"
     "The input file should contain a 3-column matrix of ratings, where the "
     "first column is the user, the second column is the item, and the third "
@@ -48,7 +50,10 @@ PROGRAM_INFO("Collaborating Filtering", "This program performs collaborative "
     "update rules\n"
     "'BatchSVD' -- SVD batch learning\n"
     "'SVDIncompleteIncremental' -- SVD incomplete incremental learning\n"
-    "'SVDCompleteIncremental' -- SVD complete incremental learning\n");
+    "'SVDCompleteIncremental' -- SVD complete incremental learning\n"
+    "\n"
+    "A trained model may be saved to a file with the --output_model_file (-M) "
+    "parameter.");
 
 // Parameters for training a model.
 PARAM_STRING("training_file", "Input dataset to perform CF on.", "t", "");