Skip to content

D
dlib
Commit e2c8b330 authored by Davis King's avatar Davis King
Browse files
Options

updated docs

parent 392ac2e6
Hide whitespace changes
Inline Side-by-side
Showing with 104 additions and 1 deletion
docs/docs/algorithms.xml
View file @ e2c8b330
......@@ -82,6 +82,11 @@
<item>uniform_random_hash</item>
<item>projection_hash</item>
<item>create_random_projection_hash</item>
<item>hash_samples</item>
<item>hash_similar_angles_64</item>
<item>hash_similar_angles_128</item>
<item>hash_similar_angles_256</item>
<item>hash_similar_angles_512</item>
</section>
<section>
......@@ -99,6 +104,82 @@
<components>
<!-- ************************************************************************* -->
<component>
<name>hash_similar_angles_64</name>
<file>dlib/lsh.h</file>
<spec_file link="true">dlib/lsh/hashes_abstract.h</spec_file>
<description>
This object is a tool for computing locality sensitive hashes that give
vectors with small angles between each other similar hash values. In
particular, this object creates 64 random planes which pass though the
origin and uses them to create a 64bit hash.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>hash_similar_angles_128</name>
<file>dlib/lsh.h</file>
<spec_file link="true">dlib/lsh/hashes_abstract.h</spec_file>
<description>
This object is a tool for computing locality sensitive hashes that give
vectors with small angles between each other similar hash values. In
particular, this object creates 128 random planes which pass though the
origin and uses them to create a 128bit hash.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>hash_similar_angles_256</name>
<file>dlib/lsh.h</file>
<spec_file link="true">dlib/lsh/hashes_abstract.h</spec_file>
<description>
This object is a tool for computing locality sensitive hashes that give
vectors with small angles between each other similar hash values. In
particular, this object creates 256 random planes which pass though the
origin and uses them to create a 256bit hash.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>hash_similar_angles_512</name>
<file>dlib/lsh.h</file>
<spec_file link="true">dlib/lsh/hashes_abstract.h</spec_file>
<description>
This object is a tool for computing locality sensitive hashes that give
vectors with small angles between each other similar hash values. In
particular, this object creates 512 random planes which pass though the
origin and uses them to create a 512bit hash.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>hash_samples</name>
<file>dlib/graph_utils_threaded.h</file>
<spec_file link="true">dlib/graph_utils/find_k_nearest_neighbors_lsh_abstract.h</spec_file>
<description>
This is a simple function for hashing a bunch of vectors using a
locality sensitive hashing object such as <a href="#hash_similar_angles_128">hash_similar_angles_128</a>.
It is also capable of running in parallel on a multi-core CPU.
</description>
</component>
<!-- ************************************************************************* -->
<component checked="true">
......
docs/docs/graph_tools.xml
View file @ e2c8b330
......@@ -53,6 +53,7 @@
<item>ordered_sample_pair</item>
<item>find_percent_shortest_edges_randomly</item>
<item>find_k_nearest_neighbors</item>
<item>find_k_nearest_neighbors_lsh</item>
<item>find_approximate_k_nearest_neighbors</item>
<item nolink="true">
<name>Distance Functions</name>
......@@ -224,7 +225,22 @@
This is a function which finds all the k nearest neighbors of a set of points and outputs
the result as a vector of <a href="#sample_pair">sample_pair</a> objects. It takes O(n^2) where
n is the number of data samples. A faster approximate version is provided by
<a href="#find_approximate_k_nearest_neighbors">find_approximate_k_nearest_neighbors</a>.
<a href="#find_approximate_k_nearest_neighbors">find_approximate_k_nearest_neighbors</a>
and <a href="#find_k_nearest_neighbors_lsh">find_k_nearest_neighbors_lsh</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>find_k_nearest_neighbors_lsh</name>
<file>dlib/graph_utils_threaded.h</file>
<spec_file link="true">dlib/graph_utils/find_k_nearest_neighbors_lsh_abstract.h</spec_file>
<description>
This function is a simple approximate form of <a href="#find_k_nearest_neighbors">find_k_nearest_neighbors</a>.
It uses locality sensitive hashing to speed up the nearest neighbor computation and is
also capable of using a multi-core CPU.
</description>
</component>
......
docs/docs/term_index.xml
View file @ e2c8b330
......@@ -149,6 +149,11 @@
<term file="bayes.html" name="node_next_parent_assignment"/>
<term file="bayes.html" name="node_cpt_filled_out"/>
<term file="algorithms.html" name="hash_samples"/>
<term file="algorithms.html" name="hash_similar_angles_64"/>
<term file="algorithms.html" name="hash_similar_angles_128"/>
<term file="algorithms.html" name="hash_similar_angles_256"/>
<term file="algorithms.html" name="hash_similar_angles_512"/>
<term file="algorithms.html" name="projection_hash"/>
<term file="algorithms.html" name="create_random_projection_hash"/>
<term file="algorithms.html" name="randomly_sample_image_features"/>
......@@ -241,6 +246,7 @@
<term file="graph_tools.html" name="order_by_distance_and_index"/>
<term file="graph_tools.html" name="find_percent_shortest_edges_randomly"/>
<term file="graph_tools.html" name="find_k_nearest_neighbors"/>
<term file="graph_tools.html" name="find_k_nearest_neighbors_lsh"/>
<term file="graph_tools.html" name="remove_short_edges"/>
<term file="graph_tools.html" name="remove_duplicate_edges"/>
<term file="graph_tools.html" name="is_ordered_by_index"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment