From 4427c91ab412bed17d23cda182fed88783815cfe Mon Sep 17 00:00:00 2001
From: Davis King <davis@dlib.net>
Date: Fri, 18 Mar 2011 13:42:31 +0000
Subject: [PATCH] updated docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%404173
---
 docs/docs/ml.xml         | 19 ++++++++++++++++++-
 docs/docs/term_index.xml |  1 +
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/docs/docs/ml.xml b/docs/docs/ml.xml
index 2ad4f4ed0..7654a5790 100644
--- a/docs/docs/ml.xml
+++ b/docs/docs/ml.xml
@@ -184,6 +184,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
          <item>load_libsvm_formatted_data</item> 
          <item>save_libsvm_formatted_data</item> 
          <item>sparse_to_dense</item>
+         <item>fix_nonzero_indexing</item>
       </section>
 
       <section>
@@ -1529,7 +1530,10 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
             <a href="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors">sparse vectors</a>.
             If you want to load data into dense vectors (i.e.
             dlib::matrix objects) then you can use the <a href="#sparse_to_dense">sparse_to_dense</a>
-            function to perform the conversion.
+            function to perform the conversion.  Also, some LIBSVM formatted files number
+            their features beginning with 1 rather than 0.  If this bothers you, then you
+            can fix it by using the <a href="#fix_nonzero_indexing">fix_nonzero_indexing</a> function
+            on the data after it is loaded.
          </description>
                                  
       </component>
@@ -1560,6 +1564,19 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
          </description>
       </component>
       
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>fix_nonzero_indexing</name>
+         <file>dlib/data_io.h</file>
+         <spec_file link="true">dlib/data_io/libsvm_io_abstract.h</spec_file>
+         <description>
+            This is a simple function that takes a std::vector of 
+            <a href="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors">sparse vectors</a> 
+            and makes sure they are zero-indexed (e.g. makes sure the first index value is zero).   
+         </description>
+      </component>
+      
    <!-- ************************************************************************* -->
       
       <component>
diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml
index 82d9d5a93..f7e710753 100644
--- a/docs/docs/term_index.xml
+++ b/docs/docs/term_index.xml
@@ -141,6 +141,7 @@
          <term file="ml.html" name="load_libsvm_formatted_data"/>
          <term file="ml.html" name="save_libsvm_formatted_data"/>
          <term file="ml.html" name="sparse_to_dense"/>
+         <term file="ml.html" name="fix_nonzero_indexing"/>
          <term link="ml.html#mlp" name="multi-layer perceptron"/>
          <term link="ml.html#mlp" name="neural network"/>
          <term file="ml.html" name="svm_pegasos"/>