Skip to content

GitLab

Commit 0cba4bac authored by Davis King's avatar Davis King
Browse files

updated docs

parent acf1b9c4
Hide whitespace changes
Inline Side-by-side
Showing with 73 additions and 2 deletions
docs/docs/imaging.xml
View file @ 0cba4bac
...@@ -226,6 +226,7 @@ ...@@ -226,6 +226,7 @@
<item>transform_image</item> <item>transform_image</item>
<item>rotate_image</item> <item>rotate_image</item>
<item>resize_image</item> <item>resize_image</item>
<item>letterbox_image</item>
<item>flip_image_left_right</item> <item>flip_image_left_right</item>
<item>flip_image_up_down</item> <item>flip_image_up_down</item>
<item>add_image_left_right_flips</item> <item>add_image_left_right_flips</item>
...@@ -1883,6 +1884,22 @@ ...@@ -1883,6 +1884,22 @@
</description> </description>
</component> </component>
<!-- ************************************************************************* -->
<component>
<name>letterbox_image</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/interpolation_abstract.h</spec_file>
<description>
Scales an image so that it fits into a size * size square, while preserving the aspect
ratio of the actual contents by appropriate 0 padding.
<examples>
<example>dnn_yolo_train_ex.cpp.html</example>
</examples>
</description>
</component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component> <component>
......
docs/docs/main_menu.xml
View file @ 0cba4bac
...@@ -296,6 +296,14 @@ ...@@ -296,6 +296,14 @@
<name>Deep Learning Max-Margin Object Detection</name> <name>Deep Learning Max-Margin Object Detection</name>
<link>dnn_mmod_ex.cpp.html</link> <link>dnn_mmod_ex.cpp.html</link>
</item> </item>
<item>
<name>Self-supervised deep feature learning</name>
<link>dnn_self_supervised_learning_ex.cpp.html</link>
</item>
<item>
<name>Training a YOLO object detector</name>
<link>dnn_yolo_train_ex.cpp.html</link>
</item>
<item> <item>
<name>Random Cropper</name> <name>Random Cropper</name>
......
docs/docs/ml.xml
View file @ 0cba4bac
...@@ -220,6 +220,14 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09 ...@@ -220,6 +220,14 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<name>mish</name> <name>mish</name>
<link>dlib/dnn/layers_abstract.h.html#mish_</link> <link>dlib/dnn/layers_abstract.h.html#mish_</link>
</item> </item>
<item>
<name>clipped_relu</name>
<link>dlib/dnn/layers_abstract.h.html#clipped_relu_</link>
</item>
<item>
<name>elu</name>
<link>dlib/dnn/layers_abstract.h.html#elu_</link>
</item>
<item> <item>
<name>relu</name> <name>relu</name>
<link>dlib/dnn/layers_abstract.h.html#relu_</link> <link>dlib/dnn/layers_abstract.h.html#relu_</link>
...@@ -317,6 +325,10 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09 ...@@ -317,6 +325,10 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<name>loss_mmod</name> <name>loss_mmod</name>
<link>#loss_mmod_</link> <link>#loss_mmod_</link>
</item> </item>
<item>
<name>loss_yolo</name>
<link>#loss_yolo_</link>
</item>
<item> <item>
<name>loss_metric</name> <name>loss_metric</name>
<link>#loss_metric_</link> <link>#loss_metric_</link>
...@@ -832,6 +844,26 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09 ...@@ -832,6 +844,26 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
</examples> </examples>
</component> </component>
<!-- ************************************************************************* -->
<component>
<name>loss_yolo_</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/loss_abstract.h</spec_file>
<description>
This object is a <a href="dlib/dnn/loss_abstract.h.html#EXAMPLE_LOSS_LAYER_">loss layer</a>
for a deep neural network. In particular, it implements the YOLO detection loss defined in
the paper:
<blockquote>YOLOv3: An Incremental Improvement by Joseph Redmon and Ali Farhadi.</blockquote>
This means you use this loss if you want to detect the locations of objects
in images.
</description>
<examples>
<example>dnn_yolo_train_ex.cpp.html</example>
</examples>
</component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component> <component>
......
docs/docs/term_index.xml
View file @ 0cba4bac
...@@ -174,6 +174,8 @@ ...@@ -174,6 +174,8 @@
<term file="dlib/dnn/layers_abstract.h.html" name="max_pool_" include="dlib/dnn.h"/> <term file="dlib/dnn/layers_abstract.h.html" name="max_pool_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="avg_pool_" include="dlib/dnn.h"/> <term file="dlib/dnn/layers_abstract.h.html" name="avg_pool_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="relu_" include="dlib/dnn.h"/> <term file="dlib/dnn/layers_abstract.h.html" name="relu_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="elu_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="clipped_relu_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="gelu_" include="dlib/dnn.h"/> <term file="dlib/dnn/layers_abstract.h.html" name="gelu_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="leaky_relu_" include="dlib/dnn.h"/> <term file="dlib/dnn/layers_abstract.h.html" name="leaky_relu_" include="dlib/dnn.h"/>
<term file="dlib/dnn/layers_abstract.h.html" name="mish_" include="dlib/dnn.h"/> <term file="dlib/dnn/layers_abstract.h.html" name="mish_" include="dlib/dnn.h"/>
...@@ -1424,12 +1426,23 @@ ...@@ -1424,12 +1426,23 @@
<term file="dlib/ref.h.html" name="cref" include="dlib/ref.h"/> <term file="dlib/ref.h.html" name="cref" include="dlib/ref.h"/>
<term file="containers.html" name="reference_wrapper" include="dlib/ref.h"/> <term file="containers.html" name="reference_wrapper" include="dlib/ref.h"/>
<term file="containers.html" name="tuple" include="dlib/tuple.h"/> <term file="containers.html" name="tuple" include="dlib/tuple.h"/>
<term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" <term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="bad_type_safe_union_cast" include="dlib/type_safe_union.h"/>
name="bad_type_safe_union_cast" include="dlib/type_safe_union.h"/> <term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="in_place_tag" include="dlib/type_safe_union.h"/>
<term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="type_safe_union_size" include="dlib/type_safe_union.h"/>
<term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="type_safe_union_alternative" include="dlib/type_safe_union.h"/>
<term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="for_each_type" include="dlib/type_safe_union.h"/>
<term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="overloaded" include="dlib/type_safe_union.h"/>
<term file="dlib/type_safe_union/type_safe_union_kernel_abstract.h.html" name="visit" include="dlib/type_safe_union.h"/>
<term file="containers.html" name="type_safe_union" include="dlib/type_safe_union.h"/> <term file="containers.html" name="type_safe_union" include="dlib/type_safe_union.h"/>
<term file="containers.html" name="array2d" include="dlib/array2d.h"/> <term file="containers.html" name="array2d" include="dlib/array2d.h"/>
<term file="dlib/invoke.h.html" name="invoke" include="dlib/invoke.h"/>
<term file="dlib/invoke.h.html" name="invoke_r" include="dlib/invoke.h"/>
<term file="dlib/invoke.h.html" name="apply" include="dlib/invoke.h"/>
<term file="dlib/invoke.h.html" name="invoke_result" include="dlib/invoke.h"/>
<term file="dlib/invoke.h.html" name="is_invocable" include="dlib/invoke.h"/>
<term file="dlib/invoke.h.html" name="make_from_tuple" include="dlib/invoke.h"/>
<term file="containers.html" name="hash_map" include="dlib/hash_map.h"/> <term file="containers.html" name="hash_map" include="dlib/hash_map.h"/>
<term file="containers.html" name="hash_set" include="dlib/hash_set.h"/> <term file="containers.html" name="hash_set" include="dlib/hash_set.h"/>
...@@ -1550,6 +1563,7 @@ ...@@ -1550,6 +1563,7 @@
<term file="imaging.html" name="transform_image" include="dlib/image_transforms.h"/> <term file="imaging.html" name="transform_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="rotate_image" include="dlib/image_transforms.h"/> <term file="imaging.html" name="rotate_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="resize_image" include="dlib/image_transforms.h"/> <term file="imaging.html" name="resize_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="letterbox_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="extract_image_chips" include="dlib/image_transforms.h"/> <term file="imaging.html" name="extract_image_chips" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="extract_image_4points" include="dlib/image_transforms.h"/> <term file="imaging.html" name="extract_image_4points" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="random_cropper" include="dlib/image_transforms.h"/> <term file="imaging.html" name="random_cropper" include="dlib/image_transforms.h"/>
......
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