[mlpack-git] master: Update documentation for changed names. (6f6173c)

gitdub at mlpack.org gitdub at mlpack.org
Thu May 26 07:26:28 EDT 2016


Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/5d1723d3305e0a97cd9a3b13561680a7eaf8676b...6f6173c7651478af406e9965cafa31e1238dad3c

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

commit 6f6173c7651478af406e9965cafa31e1238dad3c
Author: Marcus Edel <marcus.edel at fu-berlin.de>
Date:   Thu May 26 13:26:12 2016 +0200

    Update documentation for changed names.


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

6f6173c7651478af406e9965cafa31e1238dad3c
 doc/guide/iodoc.hpp                         | 2 +-
 doc/tutorials/range_search/range_search.txt | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/guide/iodoc.hpp b/doc/guide/iodoc.hpp
index 33eda5e..8cdf417 100644
--- a/doc/guide/iodoc.hpp
+++ b/doc/guide/iodoc.hpp
@@ -132,7 +132,7 @@ Documentation is automatically generated using those macros, and when the
 program is run with --help the following is displayed:
 
 @code
-$ pca --help
+$ mlpack_pca --help
 Principal Components Analysis
 
   This program performs principal components analysis on the given dataset.  It
diff --git a/doc/tutorials/range_search/range_search.txt b/doc/tutorials/range_search/range_search.txt
index a1a3a97..277a844 100644
--- a/doc/tutorials/range_search/range_search.txt
+++ b/doc/tutorials/range_search/range_search.txt
@@ -67,7 +67,7 @@ option is used so that output is given.  Further documentation on each
 individual option can be found by typing
 
 @code
-$ range_search --help
+$ mlpack_range_search --help
 @endcode
 
 @subsection cli_ex1_rstut One dataset, points with distance <= 0.01
@@ -147,7 +147,7 @@ empty.
 @subsection cli_ex2_rstut Query and reference dataset, range [1.0, 1.5]
 
 @code
-$ range_search -q query_dataset.csv -r reference_dataset.csv -n \
+$ mlpack_range_search -q query_dataset.csv -r reference_dataset.csv -n \
 > neighbors_out.csv -d distances_out.csv -L 1.0 -U 1.5 -v
 [INFO ] Loading 'reference_dataset.csv' as CSV data.  Size is 3 x 1000.
 [INFO ] Loaded reference data from 'reference_dataset.csv' (3x1000).
@@ -196,8 +196,8 @@ faster computation.  The leaf size is modifiable through the command-line
 interface, as shown below.
 
 @code
-$ range_search -r dataset.csv -n neighbors_out.csv -d distances_out.csv -L 0.7 \
-> -U 0.8 -l 15 -v
+$ mlpack_range_search -r dataset.csv -n neighbors_out.csv -d distances_out.csv \
+> -L 0.7 -U 0.8 -l 15 -v
 [INFO ] Loading 'dataset.csv' as CSV data.  Size is 3 x 1000.
 [INFO ] Loaded reference data from 'dataset.csv' (3x1000).
 [INFO ] Building reference tree...




More information about the mlpack-git mailing list