dlib README

The project's README from github.com/davisking/dlib. As one markdown file: README.md.

dlib C++ library GitHub Actions C++ Status GitHub Actions Python Status

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.

Finally, Visual Studio users should usually do everything in 64bit mode. By default Visual Studio is 32bit, both in its outputs and its own execution, so you have to explicitly tell it to use 64bits. Since it's not the 1990s anymore you probably want to use 64bits. Do that with a cmake invocation like this:

cmake .. -G "Visual Studio 14 2015 Win64" -T host=x64

Compiling your own C++ programs that use dlib

The examples folder has a CMake tutorial that tells you what to do. There are also additional instructions on the dlib web site.

Alternatively, if you are using the vcpkg dependency manager you can download and install dlib with CMake integration in a single command:

vcpkg install dlib

Compiling dlib Python API

Either fetch the latest stable release of dlib from PyPi and install that:

pip install dlib

Or fetch the very latest version from github and install that:

git clone https://github.com/davisking/dlib.git
cd dlib
pip install .

It's possible to change build settings by passing parameters to setup.py or DLIB_* environment variables. For example, setting the environment variable DLIB_NO_GUI_SUPPORT to ON will add the cmake option -DDLIB_NO_GUI_SUPPORT=ON.

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.

dlib (davisking/dlib)

Searching Database…

14.5K ·GitHub
Dlib
What is this?Dlib is a modern C++ toolkit containing machine learning algorithms and tools for building real-world machine learning and data analysis applications, with a Python API included.
Is this a C++ library, or can I use it from Python too?It is primarily a C++ library, but it also ships a Python API that you can install separately from PyPi or build from source.
How do I get dlib into my project?For C++, use the CMake tutorial in the examples folder, or install it with CMake integration via the vcpkg package manager in one command. For Python, just install the latest release from PyPi or build the latest version from GitHub.
Do I need a C++ compiler and CMake to build it?Yes, building the C++ examples and library relies on CMake and a C++ compiler; you can optionally enable AVX instructions on supported CPUs to speed things up.
Any gotchas when building on Windows?Visual Studio defaults to 32-bit builds for both its outputs and its own execution, so you need to explicitly pass a 64-bit CMake generator to build dlib properly on Windows.
How do I check that my dlib build actually works?Compile and run the included CMake-based unit test suite from the test folder; on Windows the test executable may end up in a Release subfolder.
Does dlib include GUI tools, or is it headless?It includes optional GUI support that you can disable at build time by setting the DLIBNOGUISUPPORT environment variable, which adds the corresponding CMake flag.
Who funded dlib's development?Part of the research behind dlib was supported by the Office of the Director of National Intelligence (ODNI) and IARPA under a specific contract, though the README notes this doesn't represent their official endorsement.
What are similar projects?opencv_contrib, opencv, X-AnyLabeling, libfacedetection, faceai, annoy, kornia, tesseract
Which topics is it in?face-detection, toolkit, c-plus-plus, object-detection, cmake, algorithms, neural-network, data-science, image-processing, cpp, computer-vision, c++
Creator
davisking
Size
50 MB
Stars
14.5K
Updated
CommitOct 17Releasev20.0.1Mar 29
Age
12y
Commits · 90 Days