Skip to content

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

Now that C++11 is required, I'm removing the C++11 annotations from things in 

the documentation.  I also updated a few places throughout the docs to say that
you need a C++11 compiler.
parent af3bdb22
Hide whitespace changes
Inline Side-by-side
Showing with 39 additions and 42 deletions
docs/docs/algorithms.xml
View file @ 72a6ad8d
......@@ -482,7 +482,7 @@
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>running_gradient</name>
<file>dlib/statistics/running_gradient.h</file>
<spec_file link="true">dlib/statistics/running_gradient_abstract.h</spec_file>
......@@ -496,7 +496,7 @@
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>find_upper_quantile</name>
<file>dlib/statistics/running_gradient.h</file>
<spec_file link="true">dlib/statistics/running_gradient_abstract.h</spec_file>
......@@ -510,7 +510,7 @@
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>count_steps_without_increase</name>
<file>dlib/statistics/running_gradient.h</file>
<spec_file link="true">dlib/statistics/running_gradient_abstract.h</spec_file>
......@@ -526,7 +526,7 @@
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>count_steps_without_decrease</name>
<file>dlib/statistics/running_gradient.h</file>
<spec_file link="true">dlib/statistics/running_gradient_abstract.h</spec_file>
......@@ -542,7 +542,7 @@
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>count_steps_without_decrease_robust</name>
<file>dlib/statistics/running_gradient.h</file>
<spec_file link="true">dlib/statistics/running_gradient_abstract.h</spec_file>
......
docs/docs/compile.xml
View file @ 72a6ad8d
......@@ -23,7 +23,7 @@ cd build
cmake ..
cmake --build . --config Release
</code_box>
Note that you also need to have a C++ compiler installed on your system. There are free C++ compilers
Note that you also need to have a C++11 compiler installed on your system. There are free C++11 compilers
for most operating systems. For example, Visual Studio is free on Windows and GCC is free and
works well on Mac OS X and Linux systems. If you have multiple compilers/IDEs installed then you can
tell CMake which one you want it to use via the -G option.
......@@ -109,12 +109,12 @@ tell CMake which one you want it to use via the -G option.
<h3>Compiling on Linux From Command Line</h3>
From within the examples folder, you can compile nearly all of the examples with a single command like so:
<code_box>
g++ -O3 -I.. ../dlib/all/source.cpp -lpthread -lX11 example_program_name.cpp
g++ -std=c++11 -O3 -I.. ../dlib/all/source.cpp -lpthread -lX11 example_program_name.cpp
</code_box>
Note that not all examples require this much work. For example, the svm_ex.cpp example
can be compiled with just:
<code_box>
g++ -O3 -I.. svm_ex.cpp
g++ -std=c++11 -O3 -I.. svm_ex.cpp
</code_box>
On non-Linux systems like Solaris, you might have to link to other libraries. For example, I have seen systems
......@@ -131,7 +131,7 @@ sudo apt-get install libx11-dev
(via the -l option) to the following libraries: gdi32, comctl32, user32, winmm, ws2_32, or imm32.
</p>
<h3>Compiling on Windows Using Visual Studio</h3>
<h3>Compiling on Windows Using Visual Studio 2015 or Newer</h3>
<p>
All you need to do is create an empty console project. Then add dlib/all/source.cpp to it and add the
folder containing the dlib folder to the #include search path. Then you can compile any example program
......
docs/docs/dlib.css
View file @ 72a6ad8d
......@@ -112,15 +112,6 @@ ul.tree li ul { margin-left:10px; padding:0px; }
li#term { list-style: none; }
span.cpp11
{
color: #008000;
font-family: sans-serif;
font-size: 0.8em;
margin-left: 0.3em;
}
div.include_file_more_details_wrapper
{
margin-top: 1em;
......
docs/docs/faq.xml
View file @ 72a6ad8d
......@@ -30,6 +30,10 @@
</question>
<question text="How can I use dlib in Visual Studio?">
<p>
First, note that you need a version of Visual Studio with decent
C++11 support. This means you need Visual Studio 2015 or newer.
</p>
There are instructions on the <a href="compile.html">How to Compile</a> page.
If you do not understand the instructions in the "<b>Compiling on Windows Using Visual Studio</b>" section
or are getting errors then follow the instructions in the "<b>Compiling on Any Operating System Using CMake</b>"
......@@ -357,12 +361,14 @@ cross_validate_trainer_threaded(trainer,
<!-- ************************************************************************* -->
<questions group="Deep Learning">
<question text="Why can't I use DNN module with Visual Studio?">
The deep learning toolkit in dlib requires a C++11 compiler.
Unfortunately, as of July 2016, no versions of Visual Studio fully
support C++11, so not all the deep learning code will compile.
However, all the other modules in dlib can be used in Visual Studio
without any trouble.
<question text="Why can't I use the DNN module with Visual Studio?">
You can, but you need to use Visual Studio 2015 Update 3 or newer since prior versions
had bad C++11 support. To make this as confusing as possible,
Microsoft has released multiple different versions of "Visual Studio
2015 Update 3". As of October 2016, the version available from the
Microsoft web page has good enough C++11 support to compile the DNN
tools in dlib. So make sure you have a version no older than October
2016.
</question>
<question text="Why can't I change the network architecture at runtime?">
......
docs/docs/ml.xml
View file @ 72a6ad8d
......@@ -418,7 +418,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>add_layer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -451,7 +451,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>dnn_trainer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/trainer_abstract.h</spec_file>
......@@ -475,7 +475,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>add_loss_layer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -497,7 +497,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>repeat</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -513,7 +513,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>add_tag_layer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -540,7 +540,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>add_skip_layer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -559,7 +559,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>layer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -580,7 +580,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>input</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/input_abstract.h</spec_file>
......@@ -599,7 +599,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>input_rgb_image</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/input_abstract.h</spec_file>
......@@ -614,7 +614,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>input_rgb_image_sized</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/input_abstract.h</spec_file>
......@@ -626,7 +626,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>input_rgb_image_pyramid</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/input_abstract.h</spec_file>
......@@ -646,7 +646,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>loss_mmod_</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/loss_abstract.h</spec_file>
......@@ -673,7 +673,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>test_layer</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/core_abstract.h</spec_file>
......@@ -686,7 +686,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>resizable_tensor</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/tensor_abstract.h</spec_file>
......@@ -725,7 +725,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>alias_tensor</name>
<file>dlib/dnn.h</file>
<spec_file link="true">dlib/dnn/tensor_abstract.h</spec_file>
......
docs/docs/optimization.xml
View file @ 72a6ad8d
......@@ -881,7 +881,7 @@ Or it can use the elastic net regularizer:
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>find_optimal_parameters</name>
<file>dlib/optimization/find_optimal_parameters.h</file>
<spec_file link="true">dlib/optimization/find_optimal_parameters_abstract.h</spec_file>
......@@ -896,7 +896,7 @@ Or it can use the elastic net regularizer:
<!-- ************************************************************************* -->
<component cpp11="true">
<component>
<name>elastic_net</name>
<file>dlib/optimization/elastic_net.h</file>
<spec_file link="true">dlib/optimization/elastic_net_abstract.h</spec_file>
......
docs/docs/stylesheet.xsl
View file @ 72a6ad8d
......@@ -327,7 +327,7 @@
<div class="component" >
<a href="#top"><font size='2'><center>[top]</center></font></a>
<h1 style="margin:0px;"><xsl:value-of select="name"/> <xsl:if test="@cpp11 = 'true'"><span class='cpp11'>(C++11)</span></xsl:if>
<h1 style="margin:0px;"><xsl:value-of select="name"/>
</h1>
<BR/>
<BR/>
......
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