Skip to content

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

updated docs

parent c42a26be
Hide whitespace changes
Inline Side-by-side
Showing with 43 additions and 5 deletions
docs/docs/imaging.xml
View file @ cb4a354e
......@@ -342,6 +342,7 @@
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......@@ -397,6 +398,7 @@
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......@@ -1520,6 +1522,7 @@
<examples>
<example>object_detector_ex.cpp.html</example>
<example>object_detector_advanced_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......@@ -1626,9 +1629,6 @@
to create each feature extraction region. Therefore, the detection templates will extract
features from a regular grid inside each object box.
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
</examples>
</component>
......@@ -1643,6 +1643,10 @@
except that it also outputs information regarding the selected detection templates
to standard out.
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
<!-- ************************************************************************* -->
......@@ -1657,6 +1661,7 @@
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......
docs/docs/main_menu.xml
View file @ cb4a354e
......@@ -115,6 +115,10 @@
<item nolink="true">
<name>Examples</name>
<sub>
<item>
<name>Train_Object_Detector</name>
<link>train_object_detector.cpp.html</link>
</item>
<item>
<name>Assignment_Learning</name>
<link>assignment_learning_ex.cpp.html</link>
......
docs/docs/ml.xml
View file @ cb4a354e
......@@ -219,6 +219,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
<section>
<name>Data IO</name>
<item>load_image_dataset_metadata</item>
<item>load_image_dataset</item>
<item>save_image_dataset_metadata</item>
<item>load_libsvm_formatted_data</item>
<item>save_libsvm_formatted_data</item>
......@@ -1712,6 +1713,25 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
</component>
<!-- ************************************************************************* -->
<component>
<name>load_image_dataset</name>
<file>dlib/data_io.h</file>
<spec_file link="true">dlib/data_io/load_image_dataset_abstract.h</spec_file>
<description>
This is a function which loads the list of images indicated by an
<a href="#load_image_dataset_metadata">image dataset metadata file</a>
as well as the box locations for each image. It makes loading the
data necessary to train an <a href="imaging.html#object_detector">object_detector</a>
a little more convenient.
</description>
<examples>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -1722,7 +1742,9 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
dlib comes with a graphical tool for annotating images with
labeled rectangles. The tool produces an XML file containing these
annotations. Therefore, load_image_dataset_metadata() is a routine
for parsing these XML files.
for parsing these XML files. Note also that this is the metadata
format used by the image labeling tool included with dlib in the
tools/imglab folder.
</description>
</component>
......@@ -1737,7 +1759,9 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
This routine is a tool for saving labeled image metadata to an
XML file. In particular, this routine saves the metadata into a
form which can be read by the <a href="#load_image_dataset_metadata">load_image_dataset_metadata</a>
routine.
routine. Note also that this is the metadata
format used by the image labeling tool included with dlib in the
tools/imglab folder.
</description>
</component>
......@@ -2281,6 +2305,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
<examples>
<example>object_detector_ex.cpp.html</example>
<example>object_detector_advanced_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......@@ -2299,6 +2324,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
<examples>
<example>object_detector_ex.cpp.html</example>
<example>object_detector_advanced_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......@@ -2462,6 +2488,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
<examples>
<example>object_detector_ex.cpp.html</example>
<example>object_detector_advanced_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
</component>
......
docs/docs/parsing.xml
View file @ cb4a354e
......@@ -422,6 +422,7 @@
<examples>
<example>compress_stream_ex.cpp.html</example>
<example>train_object_detector.cpp.html</example>
</examples>
<implementations>
......
docs/docs/term_index.xml
View file @ cb4a354e
......@@ -185,6 +185,7 @@
<term file="dlib/data_io/image_dataset_metadata.h.html" name="dataset"/>
<term link="ml.html#load_image_dataset_metadata" name="image_dataset_metadata"/>
<term file="ml.html" name="load_image_dataset_metadata"/>
<term file="ml.html" name="load_image_dataset"/>
<term file="ml.html" name="save_image_dataset_metadata"/>
<term file="ml.html" name="load_libsvm_formatted_data"/>
<term file="ml.html" name="save_libsvm_formatted_data"/>
......
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