Skip to content

D
dlib
Commit 10cf3028 authored by Davis King's avatar Davis King
Browse files
Options

updated intro and a few other things

parent 933fd7e7
Hide whitespace changes
Inline Side-by-side
Showing with 59 additions and 26 deletions
docs/docs/containers.xml
View file @ 10cf3028
...@@ -9,8 +9,9 @@ ...@@ -9,8 +9,9 @@
<body> <body>
<br/><br/> <br/><br/>
<p> <p>
Many of these containers were inspired by the RESOLVE/C++ course Many of these containers were inspired by the work of the <a
sequence at Ohio State. As such, many of the objects do not support href="http://www.cse.ohio-state.edu/~weide/rsrg/index.html">Reusable
Software Research Group</a> at Ohio State. As such, many of the objects do not support
copying in any form, only swapping is allowed. That is, when objects copying in any form, only swapping is allowed. That is, when objects
are added or removed from most of these containers they are swapped in are added or removed from most of these containers they are swapped in
and out, not copied. and out, not copied.
......
docs/docs/faq.xml
View file @ 10cf3028
...@@ -6,6 +6,32 @@ ...@@ -6,6 +6,32 @@
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<questions group="General"> <questions group="General">
<question text="How can I cite dlib?">
If you use dlib in your research then please use the following citation:
<br/>
<br/>
Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09a.pdf">Dlib-ml: A Machine Learning Toolkit</a>.
<i>Journal of Machine Learning Research</i> 10, pp. 1755-1758, 2009
<br/>
<pre>
@Article{dlib09,
author = {Davis E. King},
title = {Dlib-ml: A Machine Learning Toolkit},
journal = {Journal of Machine Learning Research},
year = {2009},
volume = {10},
pages = {1755-1758},
}
</pre>
</question>
<!-- ****************************************** -->
<question text="Why isn't serialization working?"> <question text="Why isn't serialization working?">
Here are the possibilities: Here are the possibilities:
<ul> <ul>
......
docs/docs/intro.xml
View file @ 10cf3028
...@@ -26,34 +26,37 @@ ...@@ -26,34 +26,37 @@
<p> <p>
Dlib is a cross-platform open source software library written in the C++ programming Dlib is a general purpose cross-platform open source software library written in the C++ programming
language. Its design is heavily influenced by ideas from design by contract and component-based language. Its design is heavily influenced by ideas from design by contract and component-based
software engineering. This means it is, first and foremost, a collection of independent software engineering. This means it is, first and foremost, a collection of independent
software components, each accompanied by extensive documentation and thorough debugging modes. software components, each accompanied by extensive documentation and thorough debugging modes.
</p> </p>
<p> <p>
Generally speaking, there is no focus on any specific domain in the library. It contains a variety Since development began in 2002, dlib has grown to include a wide
of software objects for dealing with networking, threads (message passing, futures, etc.), variety of tools. In particular, it now contains software objects
graphical interfaces, complex data structures, linear algebra, machine learning, XML and text for dealing with networking, threads, graphical interfaces, complex
parsing, numerical optimization, Bayesian networks, and numerous other tasks. data structures, linear algebra, statistical machine learning, image
processing, data mining, XML and text parsing, numerical
optimization, Bayesian networks, and numerous other tasks. In
recent years, much of the development has been focused on creating
a broad set of statistical machine learning tools. However, dlib
remains a general purpose library and <a href="howto_contribute.html">welcomes contributions</a> of high
quality software components useful in any domain.
</p> </p>
<p> <p>
The most persistent theme in the library is the ubiquitous application of contract programming. Part of the development philosophy of dlib is a dedication to
You can read about this on the <a href="howto_contribute.html#1">how to contribute</a> page portability and ease of use. Therefore, all code in dlib is designed
for more information. However, from the point of view of a user of this library it basically to be as portable as possible and similarly to not require a user to
means there exists complete and precise documentation for every function and class in the library configure or install anything. To help achieve this, all platform
as well as aggressive debugging modes that can be enabled. specific code is confined inside the API wrappers. Everything else is
</p> either layered on top of those wrappers or is written in pure ISO
standard C++. Currently the library is known to work on OS X, MS
<p> Windows, Linux, Solaris, the BSDs, and HP-UX. It should work on any
I always try to make sure everything is as portable as possible. All platform specific code is POSIX platform but I haven't had the opportunity to test it on any
confined inside the API wrappers. Everything else is either layered on top of those wrappers others (if you have access to other platforms and would like to help
or is written in pure ISO standard C++. Currently the library is known to work on OS X, increase this list then let me know).
MS Windows, Linux, Solaris, the BSDs, and HP-UX. It should work on any POSIX platform but I
haven't had the opportunity to test it on any others (if you have access to other platforms and
would like to help increase this list then let me know).
</p> </p>
<p> <p>
The rest of this page explains everything you need to know to get started using the library. It The rest of this page explains everything you need to know to get started using the library. It
...@@ -62,13 +65,16 @@ ...@@ -62,13 +65,16 @@
page. Or if you are having trouble finding where a particular object's documentation is located you may page. Or if you are having trouble finding where a particular object's documentation is located you may
be able to find it by consulting the <a href="term_index.html">index</a>.</p> be able to find it by consulting the <a href="term_index.html">index</a>.</p>
<p> <p>
The library is also covered by the very liberal Boost Software License so feel free to use it The library is also covered by the very liberal Boost Software License
however you like. so feel free to use it any way you like. However, if you use dlib in
your research then please cite <a href="faq.html#How can I cite dlib?">its Journal of Machine Learning Research paper</a> when
publishing.
</p> </p>
<p> <p>
Much of the organization and notation used in this library I learned from the Finally, I must give some credit to the <a
<a href="http://www.cse.ohio-state.edu/~weide/sce/now/">Software Component Engineering</a> href="http://www.cse.ohio-state.edu/~weide/rsrg/index.html">Reusable
course sequence at OSU. Software Research Group</a> at Ohio State since they taught me much
of the software engineering techniques used in the creation of this library.
</p> </p>
......
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