updated docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%404173
This commit is contained in:
Davis King 2011-03-18 13:42:31 +00:00
parent a6b8cc9b7f
commit 4427c91ab4
2 changed files with 19 additions and 1 deletions

View File

@ -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>load_libsvm_formatted_data</item>
<item>save_libsvm_formatted_data</item> <item>save_libsvm_formatted_data</item>
<item>sparse_to_dense</item> <item>sparse_to_dense</item>
<item>fix_nonzero_indexing</item>
</section> </section>
<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>. <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. 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> 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> </description>
</component> </component>
@ -1560,6 +1564,19 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
</description> </description>
</component> </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> <component>

View File

@ -141,6 +141,7 @@
<term file="ml.html" name="load_libsvm_formatted_data"/> <term file="ml.html" name="load_libsvm_formatted_data"/>
<term file="ml.html" name="save_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="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="multi-layer perceptron"/>
<term link="ml.html#mlp" name="neural network"/> <term link="ml.html#mlp" name="neural network"/>
<term file="ml.html" name="svm_pegasos"/> <term file="ml.html" name="svm_pegasos"/>