# Technical Documentation: davisking/dlib
> ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/davisking/dlib)
### Overview (`README.md`)
# dlib C++ library [](https://github.com/davisking/dlib/actions/workflows/build_cpp.yml) [](https://github.com/davisking/dlib/actions/workflows/build_python.yml)
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](http://dlib.net) for the main project documentation and API reference.
## Compiling dlib C++ example programs
You need a C++17 compiler and CMake. Go into the examples folder and type:
```bash
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:
```bash
mkdir build; cd build; cmake .. -DUSE_AVX_INSTRUCTIONS=1; cmake --build .
```
Doing so will make some things run faster.
Visual Studio users can explicitly select a 64bit target and compiler with a CMake invocation like this:
```bash
cmake .. -G "Visual Studio 17 2022" -A x64 -T host=x64
```
## Compiling your own C++ programs that use dlib
The examples folder has a [CMake tutorial](https://github.com/davisking/dlib/blob/master/examples/CMakeLists.txt) that tells you what to do. There are also additional instructions on the [dlib web site](http://dlib.net/compile.html).
Alternatively, if you are using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager you can download and install dlib with CMake integration in a single command:
```bash
vcpkg install dlib
```
## Compiling dlib Python API
Either fetch the latest stable release of dlib from PyPi and install that:
```bash
pip install dlib
```
Or fetch the very latest version from github and install that:
```bash
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:
```bash
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](https://github.com/davisking/dlib/blob/master/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.
---
### README (`docs/README.txt`)
This "package" is just a copy of the stuff I use to generate the documentation
for the dlib library. It contains a copy of the XSLT and XML I use to
generate the HTML documentation.
The current version of these files can be obtained from the dlib GitHub
repository at: https://github.com/davisking/dlib
======================== Overview ========================
I write all my documentation in XML files. If you look through the files in
the docs folder you will see each of them. There is also a stylesheet.xsl
file which contains all the XSLT I wrote to transform XML files into HTML.
Anyway, I use that stylesheet to generate the dlib documentation from those
XML files.
There is also a stylesheet inside the docs/chm folder (htmlhelp_stylesheet.xsl)
that knows how to look at the XML files and generate the table of contents
files needed by the htmlhelp tool (the thing that makes chm help files).
Also note that the first 80 or so lines of the stylesheet.xsl file contains
stuff specific to the dlib project and thus should be changed or removed
as appropriate if you want to reuse it for a different project.
======================== Installing the required tools ========================
To begin with, the XML and XSLT is usable on any operating system, however,
all the scripts I have in the docs folder that automate everything are bash
shell scripts. I also use stuff like wine and other Linux tools and I have
only ever tested any of this in Debian. So if you want to use all the scripts
then you should probably run this stuff in Linux. But if not you can probably
hack something together :)
There are four scripts in the docs folder.
- testenv_rel: This script tests your environment for all the needed utilities.
Run it and it should tell you what else you need to install.
Note that the htmlify utility is something I wrote and is in
dlib's repository in the tools/htmlify folder. You should
build and install it. (go into that folder, make a subfolder
called build, then cd into build and say: "cmake ..; make;
sudo make install". You will need to install cmake if you
don't have it already)
- makedocs: This remakes all the HTML documentation by pulling files out
of the dlib repository. If you want to use this stuff for your
own projects you will need to edit this file a bit.
Note that this script puts its output in the docs/web and
docs/chm/docs folders. I use the chm folder for off-line
documentation while the web folder contains what goes onto
dlib.net. Both sets of HTML are generated from the same XML
files and are mostly the same. You will see and
tags inside the XML though in cases where the two
differ.
- makerel: Runs makedocs as well as creates tar and zip files of the project.
It also runs htmlhelp in wine to generate the chm help files.
Note that you will need to run docs/chm/htmlhelp/setup_htmlhelp.sh
before it will work in wine.
======================== License for documentation files ========================
To the extent possible under law, Davis E King has waived all copyright and
related or neighboring rights to dlib documentation (XML, HTML, and XSLT files).
This work is published from United States.
That is, I (Davis the author) don't care what you do with this. So do
whatever you want :)
---
### Docs Kernel 1a (`docs/docs/kernel_1a.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 86995 4.576 no
play: 125179 75430 4.82062 no
html: 24603 16209 5.27058 no
Csrc: 11150 7084 5.08269 no
list: 3721 2224 4.78151 no
Excl: 1029744 440758 3.42421 no
tech: 426754 248345 4.65552 no
poem: 481861 273394 4.53897 no
fax: 513216 75036 1.16966 no
SPRC: 38240 25660 5.3682 no
man: 4227 2663 5.03998 no
average: 4.42981
time: 875ms
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 72533 5.21534 no
book1: 768771 435527 4.53219 no
book2: 610856 364597 4.7749 no
geo: 102400 72600 5.67188 no
news: 377109 244377 5.18422 no
obj1: 21504 16183 6.02046 no
obj2: 246814 189902 6.15531 no
paper1: 53161 33144 4.98772 no
paper2: 82199 47398 4.613 no
pic: 513216 75036 1.16966 no
progc: 39611 25885 5.22784 no
progl: 71646 42688 4.76655 no
progp: 49379 30180 4.88953 no
trans: 93695 64603 5.51603 no
average: 4.9089
time: 1.11sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 7 56 no
aaa: 100000 20 0.0016 no
alphabet: 100000 58912 4.71296 no
random: 100000 75202 6.01616 no
average: 16.6827
time: 93ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1162352 2.00462 no
bible: 4047392 2194059 4.33674 no
word: 2473400 1542086 4.98774 no
average: 3.77637
time: 3.766sec
---
### Docs Kernel 1b (`docs/docs/kernel_1b.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 66165 3.48033 no
play: 125179 54572 3.48761 no
html: 24603 11661 3.79173 no
Csrc: 11150 4733 3.39587 no
list: 3721 1629 3.50228 no
Excl: 1029744 343447 2.66821 no
tech: 426754 188332 3.5305 no
poem: 481861 204240 3.39085 no
fax: 513216 54127 0.843731 no
SPRC: 38240 18307 3.82992 no
man: 4227 2100 3.97445 no
average: 3.26323
time: 844ms
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 48130 3.46069 no
book1: 768771 346572 3.6065 no
book2: 610856 288605 3.77968 no
geo: 102400 61124 4.77531 no
news: 377109 196085 4.15975 no
obj1: 21504 12445 4.62984 no
obj2: 246814 127142 4.12106 no
paper1: 53161 25438 3.82807 no
paper2: 82199 37295 3.62973 no
pic: 513216 54127 0.843731 no
progc: 39611 19090 3.85549 no
progl: 71646 29773 3.32446 no
progp: 49379 20795 3.36904 no
trans: 93695 40922 3.49406 no
average: 3.6341
time: 1.109sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 7 56 no
aaa: 100000 20 0.0016 no
alphabet: 100000 83 0.00664 no
random: 100000 77775 6.222 no
average: 15.5576
time: 94ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1151913 1.98662 no
bible: 4047392 1651476 3.26428 no
word: 2473400 1133090 3.66488 no
average: 2.97193
time: 3.672sec
---
### Docs Kernel 1c (`docs/docs/kernel_1c.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 51810 2.72525 no
play: 125179 44002 2.8121 no
html: 24603 8602 2.79706 no
Csrc: 11150 3399 2.43874 no
list: 3721 1272 2.73475 no
Excl: 1029744 237165 1.84252 no
tech: 426754 147090 2.75737 no
poem: 481861 169981 2.82208 no
fax: 513216 54230 0.845336 no
SPRC: 38240 15190 3.17782 no
man: 4227 1763 3.33665 no
average: 2.57179
time: 1.031sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 37264 2.67939 no
book1: 768771 280052 2.91428 no
book2: 610856 221616 2.90237 no
geo: 102400 62115 4.85273 no
news: 377109 155282 3.29416 no
obj1: 21504 11235 4.17969 no
obj2: 246814 97319 3.15441 no
paper1: 53161 19664 2.95916 no
paper2: 82199 29837 2.90388 no
pic: 513216 54230 0.845336 no
progc: 39611 14610 2.9507 no
progl: 71646 21637 2.41599 no
progp: 49379 14204 2.30122 no
trans: 93695 27848 2.37776 no
average: 2.90936
time: 1.297sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 7 56 no
aaa: 100000 18 0.00144 no
alphabet: 100000 65 0.0052 no
random: 100000 90704 7.25632 no
average: 15.8157
time: 203ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1141437 1.96855 no
bible: 4047392 1263237 2.49689 no
word: 2473400 876621 2.83536 no
average: 2.4336
time: 3.391sec
---
### Docs Kernel 1da (`docs/docs/kernel_1da.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 45580 2.39754 no
play: 125179 42432 2.71176 no
html: 24603 7745 2.51839 no
Csrc: 11150 3165 2.27085 no
list: 3721 1238 2.66165 no
Excl: 1029744 194875 1.51397 no
tech: 426754 111838 2.09653 no
poem: 481861 148110 2.45897 no
fax: 513216 56075 0.874096 no
SPRC: 38240 14248 2.98075 no
man: 4227 1736 3.28555 no
average: 2.34273
time: 1.812sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 29161 2.09676 no
book1: 768771 235667 2.4524 no
book2: 610856 165032 2.16132 no
geo: 102400 67663 5.28617 no
news: 377109 128148 2.71853 no
obj1: 21504 10750 3.99926 no
obj2: 246814 82894 2.68685 no
paper1: 53161 17398 2.61816 no
paper2: 82199 26449 2.57414 no
pic: 513216 56075 0.874096 no
progc: 39611 13188 2.6635 no
progl: 71646 17135 1.9133 no
progp: 49379 11764 1.90591 no
trans: 93695 19602 1.67369 no
average: 2.54458
time: 2.36sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 6 48 no
aaa: 100000 19 0.00152 no
alphabet: 100000 66 0.00528 no
random: 100000 89652 7.17216 no
average: 13.7947
time: 375ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1130363 1.94945 no
bible: 4047392 871537 1.72266 no
word: 2473400 589688 1.9073 no
average: 1.8598
time: 4.484sec
---
### Docs Kernel 1db (`docs/docs/kernel_1db.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 47843 2.51658 no
play: 125179 45069 2.88029 no
html: 24603 7914 2.57334 no
Csrc: 11150 3279 2.35265 no
list: 3721 1281 2.7541 no
Excl: 1029744 210286 1.6337 no
tech: 426754 115826 2.17129 no
poem: 481861 157348 2.61234 no
fax: 513216 56477 0.880362 no
SPRC: 38240 14466 3.02636 no
man: 4227 1780 3.36882 no
average: 2.43362
time: 2.296sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 29758 2.13969 no
book1: 768771 247700 2.57762 no
book2: 610856 168694 2.20928 no
geo: 102400 67817 5.2982 no
news: 377109 126675 2.68729 no
obj1: 21504 10871 4.04427 no
obj2: 246814 82948 2.6886 no
paper1: 53161 18113 2.72576 no
paper2: 82199 27700 2.6959 no
pic: 513216 56477 0.880362 no
progc: 39611 13622 2.75115 no
progl: 71646 17263 1.92759 no
progp: 49379 12032 1.94933 no
trans: 93695 19505 1.6654 no
average: 2.5886
time: 2.86sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 6 48 no
aaa: 100000 20 0.0016 no
alphabet: 100000 66 0.00528 no
random: 100000 88475 7.078 no
average: 13.7712
time: 531ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1130433 1.94957 no
bible: 4047392 844807 1.66983 no
word: 2473400 504129 1.63056 no
average: 1.74999
time: 5.266sec
---
### Docs Kernel 1ea (`docs/docs/kernel_1ea.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 40695 2.14059 no
play: 125179 37421 2.39152 no
html: 24603 6859 2.2303 no
Csrc: 11150 2792 2.00323 no
list: 3721 1084 2.33056 no
Excl: 1029744 156897 1.21892 no
tech: 426754 102805 1.9272 no
poem: 481861 136664 2.26894 no
fax: 513216 51109 0.796686 no
SPRC: 38240 12590 2.63389 no
man: 4227 1530 2.89567 no
average: 2.07614
time: 3.062sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 26039 1.87228 no
book1: 768771 218772 2.27659 no
book2: 610856 151985 1.99045 no
geo: 102400 59371 4.63836 no
news: 377109 115334 2.4467 no
obj1: 21504 9832 3.65774 no
obj2: 246814 75065 2.43309 no
paper1: 53161 15263 2.29687 no
paper2: 82199 23368 2.27429 no
pic: 513216 51109 0.796686 no
progc: 39611 11549 2.33248 no
progl: 71646 15297 1.70806 no
progp: 49379 10447 1.69254 no
trans: 93695 17677 1.50932 no
average: 2.28039
time: 4.172sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 7 56 no
aaa: 100000 17 0.00136 no
alphabet: 100000 65 0.0052 no
random: 100000 82599 6.60792 no
average: 15.6536
time: 672ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1130095 1.94899 no
bible: 4047392 848956 1.67803 no
word: 2473400 542983 1.75623 no
average: 1.79442
time: 6.516sec
---
### Docs Kernel 1eb (`docs/docs/kernel_1eb.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 40220 2.1156 no
play: 125179 37451 2.39344 no
html: 24603 6819 2.21729 no
Csrc: 11150 2770 1.98744 no
list: 3721 1085 2.33271 no
Excl: 1029744 158436 1.23088 no
tech: 426754 100243 1.87917 no
poem: 481861 136151 2.26042 no
fax: 513216 50374 0.785229 no
SPRC: 38240 12387 2.59142 no
man: 4227 1528 2.89189 no
average: 2.06232
time: 4.875sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 25279 1.81764 no
book1: 768771 216389 2.25179 no
book2: 610856 146986 1.92498 no
geo: 102400 58768 4.59125 no
news: 377109 109292 2.31852 no
obj1: 21504 9819 3.6529 no
obj2: 246814 72662 2.3552 no
paper1: 53161 15128 2.27656 no
paper2: 82199 23186 2.25657 no
pic: 513216 50374 0.785229 no
progc: 39611 11434 2.30926 no
progl: 71646 14712 1.64274 no
progp: 49379 10210 1.65414 no
trans: 93695 16885 1.4417 no
average: 2.23418
time: 5.421sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 7 56 no
aaa: 100000 17 0.00136 no
alphabet: 100000 64 0.00512 no
random: 100000 81881 6.55048 no
average: 15.6392
time: 907ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1129161 1.94738 no
bible: 4047392 794809 1.571 no
word: 2473400 454450 1.46988 no
average: 1.66275
time: 7.39sec
---
### Docs Kernel 1ec (`docs/docs/kernel_1ec.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 40367 2.12334 no
play: 125179 37785 2.41478 no
html: 24603 6828 2.22022 no
Csrc: 11150 2710 1.94439 no
list: 3721 1084 2.33056 no
Excl: 1029744 162760 1.26447 no
tech: 426754 100488 1.88376 no
poem: 481861 139110 2.30955 no
fax: 513216 50276 0.783701 no
SPRC: 38240 12219 2.55628 no
man: 4227 1533 2.90135 no
average: 2.06658
time: 5.484sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 25153 1.80858 no
book1: 768771 220128 2.2907 no
book2: 610856 146040 1.91259 no
geo: 102400 58737 4.58883 no
news: 377109 108774 2.30753 no
obj1: 21504 9823 3.65439 no
obj2: 246814 71148 2.30613 no
paper1: 53161 15116 2.27475 no
paper2: 82199 23346 2.27214 no
pic: 513216 50276 0.783701 no
progc: 39611 11351 2.29249 no
progl: 71646 14125 1.5772 no
progp: 49379 9966 1.61461 no
trans: 93695 16068 1.37194 no
average: 2.21826
time: 6.188sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 7 56 no
aaa: 100000 17 0.00136 no
alphabet: 100000 65 0.0052 no
random: 100000 81869 6.54952 no
average: 15.639
time: 1.109sec
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1160064 2.00068 no
bible: 4047392 760498 1.50319 no
word: 2473400 422419 1.36628 no
average: 1.62338
time: 11.203sec
---
### Docs Kernel 2a (`docs/docs/kernel_2a.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 55655 2.9275 no
play: 125179 49648 3.17293 no
html: 24603 8345 2.71349 no
Csrc: 11150 3514 2.52126 no
list: 3721 1379 2.96479 no
Excl: 1029744 72617 0.564156 no
tech: 426754 145403 2.72575 no
poem: 481861 196109 3.25586 no
fax: 513216 49740 0.775346 no
SPRC: 38240 13253 2.77259 no
man: 4227 1857 3.51455 no
average: 2.53711
time: 4.641sec
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 35687 2.566 no
book1: 768771 313140 3.2586 no
book2: 610856 210661 2.7589 no
geo: 102400 61070 4.77109 no
news: 377109 143307 3.04012 no
obj1: 21504 11004 4.09375 no
obj2: 246814 83289 2.69965 no
paper1: 53161 19433 2.9244 no
paper2: 82199 30671 2.98505 no
pic: 513216 49740 0.775346 no
progc: 39611 14142 2.85618 no
progl: 71646 17196 1.92011 no
progp: 49379 12045 1.95144 no
trans: 93695 19849 1.69478 no
average: 2.73539
time: 4.89sec
The Artificial Corpus
file size packed size bpb corruption
a: 1 6 48 no
aaa: 100000 58 0.00464 no
alphabet: 100000 87 0.00696 no
random: 100000 77815 6.2252 no
average: 13.5592
time: 235ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 1349400 2.32721 no
bible: 4047392 1206327 2.3844 no
word: 2473400 703195 2.27442 no
average: 2.32868
time: 8.75sec
---
### Docs Kernel 3a (`docs/docs/kernel_3a.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 118620 6.2395 no
play: 125179 103761 6.63121 no
html: 24603 14067 4.57408 no
Csrc: 11150 5805 4.16502 no
list: 3721 2142 4.60521 no
Excl: 1029744 390978 3.03748 no
tech: 426754 310347 5.81782 no
poem: 481861 435150 7.22449 no
fax: 513216 116298 1.81285 no
SPRC: 38240 23076 4.82762 no
man: 4227 3177 6.01278 no
average: 4.99528
time: 547ms
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 68949 4.95764 no
book1: 768771 683415 7.11177 no
book2: 610856 435186 5.69936 no
geo: 102400 105111 8.2118 no
news: 377109 266382 5.65103 no
obj1: 21504 15714 5.84598 no
obj2: 246814 139671 4.52717 no
paper1: 53161 37476 5.63962 no
paper2: 82199 63198 6.15073 no
pic: 513216 116298 1.81285 no
progc: 39611 25398 5.12948 no
progl: 71646 31905 3.56252 no
progp: 49379 20943 3.39302 no
trans: 93695 34056 2.90782 no
average: 5.04291
time: 610ms
The Artificial Corpus
file size packed size bpb corruption
a: 1 9 72 no
aaa: 100000 3771 0.30168 no
alphabet: 100000 486 0.03888 no
random: 100000 112491 8.99928 no
average: 20.335
time: 47ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 4752396 8.1961 no
bible: 4047392 2649303 5.23656 no
word: 2473400 1452177 4.69694 no
average: 6.0432
time: 2.5sec
---
### Docs Kernel 3b (`docs/docs/kernel_3b.txt`)
The Canterbury Corpus
file size packed size bpb corruption
text: 152089 111537 5.86693 no
play: 125179 101457 6.48396 no
html: 24603 13914 4.52433 no
Csrc: 11150 5760 4.13274 no
list: 3721 2160 4.64391 no
Excl: 1029744 407466 3.16557 no
tech: 426754 291483 5.46419 no
poem: 481861 417897 6.93805 no
fax: 513216 114138 1.77918 no
SPRC: 38240 23184 4.85021 no
man: 4227 3159 5.97871 no
average: 4.89343
time: 734ms
The Calgary Corpus
file size packed size bpb corruption
bib: 111261 63729 4.58231 no
book1: 768771 655227 6.81844 no
book2: 610856 409392 5.36155 no
geo: 102400 108099 8.44523 no
news: 377109 259065 5.49581 no
obj1: 21504 15768 5.86607 no
obj2: 246814 138564 4.49128 no
paper1: 53161 35901 5.40261 no
paper2: 82199 60291 5.86781 no
pic: 513216 114138 1.77918 no
progc: 39611 24984 5.04587 no
progl: 71646 31113 3.47408 no
progp: 49379 20772 3.36532 no
trans: 93695 33093 2.82559 no
average: 4.9158
time: 907ms
The Artificial Corpus
file size packed size bpb corruption
a: 1 9 72 no
aaa: 100000 3771 0.30168 no
alphabet: 100000 486 0.03888 no
random: 100000 112509 9.00072 no
average: 20.3353
time: 78ms
The Large Corpus
file size packed size bpb corruption
E.coli: 4638690 4747257 8.18724 no
bible: 4047392 2466675 4.87558 no
word: 2473400 1301805 4.21058 no
average: 5.7578
time: 3.25sec
---
### Docs Chm README (`docs/docs/chm/README.txt`)
The Table of Contents.hhc file is auto generated by the toc.xml and htmlhelp_stylesheet.xsl files.
You really can edit it if you want but I suggest you use the stylesheet to auto generate it instead.
If you want to regenerate the table of contents file you can do so with
the command "msxsl toc.xml htmlhelp_stylesheet.xsl" if you are using msxsl.exe.
---
### Docs Python Index (`docs/docs/python/index.rst`)
.. image:: ../dlib-logo.png
:alt: Dlib C++ Library
:target: http://dlib.net
Dlib is principally a C++ library, however, you can use a number of its tools
from python applications. This page documents the python API for working with
these dlib tools. If you haven't done so already, you should probably look at
the python example programs first before consulting this reference. These
example programs are little mini-tutorials for using dlib from python. They
are listed on the left of the main dlib web page.
Classes
==============================================
.. include:: classes.txt
Functions
==============================================
.. include:: functions.txt
Constants
==============================================
.. include:: constants.txt
Detailed API Listing
==============================================
.. toctree::
:maxdepth: 2
.. automodule:: _dlib_pybind11
:members:
:undoc-members:
.. automodule:: _dlib_pybind11.cuda
:members:
:undoc-members:
.. automodule:: _dlib_pybind11.image_dataset_metadata
:members:
:undoc-members:
---
--- METRICS ---
- Files Extracted: 15
- Estimated Token Budget: ~9361 tokens
- Canonical Reference: https://codewiki.google/github.com/davisking/dlib