Go to file
Davis King 70eecbd6b0 Fixed compiler error on ubuntu 16.04 2016-08-13 09:03:16 -04:00
dlib Added workaround for a bug in cuDNN5.1 which causes 2016-08-11 22:12:40 -04:00
docs updated docs 2016-08-11 19:07:30 -04:00
examples Renamed something to avoid name clash with standard library. 2016-07-22 16:22:57 -04:00
python_examples Changed URLs to point to dlib.net instead of sourceforge.net 2016-06-25 14:00:38 -04:00
tools Fixed compiler error on ubuntu 16.04 2016-08-13 09:03:16 -04:00
.gitignore ignore dist directory as well as egg directories 2015-08-19 16:25:10 -07:00
.hgignore updated ignore list 2016-05-31 12:27:31 -04:00
.hgtags Added tag v19.0 for changeset 7210589728f6 2016-06-25 15:03:31 -04:00
CMakeLists.txt Support building dlib from a top-level CMakeLists file 2016-02-26 08:53:49 -05:00
MANIFEST.in package no build binaies in sdist 2015-08-20 15:17:48 -07:00
README.txt updated aknowledgement 2016-04-04 15:43:12 -04:00
setup.py setup.py: Don't fail if pip fails in cmake err msg 2016-06-11 08:57:20 +05:30

README.txt

                              dlib C++ library

Dlib is a modern C++ toolkit containing machine learning algorithms and tools
for creating complex software in C++ to solve real world problems.  See
http://dlib.net for the main project documentation and API reference.



COMPILING DLIB C++ EXAMPLE PROGRAMS
   Go into the examples folder and type:
       mkdir build; cd build; cmake .. ; cmake --build .
   That will build all the examples.  If you have a CPU that supports AVX
   instructions then turn them on like this:
       mkdir build; cd build; cmake .. -DUSE_AVX_INSTRUCTIONS=1; cmake --build .
   Doing so will make some things run faster.

COMPILING DLIB Python API
   Before you can run the Python example programs you must compile dlib. Type:
       python setup.py install
   or type
       python setup.py install --yes USE_AVX_INSTRUCTIONS
   if you have a CPU that supports AVX instructions, since this makes some
   things run faster.  

RUNNING THE UNIT TEST SUITE
   Type the following to compile and run the dlib unit test suite:
       cd dlib/test
       mkdir build
       cd build
       cmake ..
       cmake --build . --config Release
       ./dtest --runall

   Note that on windows your compiler might put the test executable in a
   subfolder called Release.  If that's the case then you have to go to that
   folder before running the test.

This library is licensed under the Boost Software License, which can be found
in dlib/LICENSE.txt.  The long and short of the license is that you can use
dlib however you like, even in closed source commercial software.

Dlib Sponsors:
  This research is based in part upon work supported by the Office of the
  Director of National Intelligence (ODNI), Intelligence Advanced Research
  Projects Activity (IARPA) under contract number 2014-14071600010. The
  views and conclusions contained herein are those of the authors and
  should not be interpreted as necessarily representing the official policies
  or endorsements, either expressed or implied, of ODNI, IARPA, or the U.S.
  Government.