Davis E. King. Dlib-ml: A Machine Learning Toolkit. 
   Journal of Machine Learning Research 10, pp. 1755-1758, 2009

@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},
}
         

[top]

batch

This is a convenience function for creating batch_trainer objects.

Specification: dlib/svm/pegasos_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

batch_cached

This is a convenience function for creating batch_trainer objects that are setup to use a kernel matrix cache.

Specification: dlib/svm/pegasos_abstract.h
File to include: dlib/svm.h

[top]

batch_trainer

This is a batch trainer object that is meant to wrap online trainer objects that create decision_functions. It turns an online learning algorithm such as svm_pegasos into a batch learning object. This allows you to use objects like svm_pegasos with functions (e.g. cross_validate_trainer) that expect batch mode training objects.

Specification: dlib/svm/pegasos_abstract.h
File to include: dlib/svm.h

[top]

compute_mean_squared_distance

This is a function that simply finds the average squared distance between all pairs of a set of data samples. It is often convenient to use the reciprocal of this value as the estimate of the gamma parameter of the radial_basis_kernel.

Specification: dlib/svm/feature_ranking_abstract.h
File to include: dlib/svm.h

[top]

cross_validate_trainer

Performs k-fold cross validation on a user supplied trainer object such as the svm_nu_trainer or rbf_network_trainer.

Specification: dlib/svm/svm_abstract.h
File to include: dlib/svm.h
Code Examples: 1, 2

[top]

cross_validate_trainer_threaded

Performs k-fold cross validation on a user supplied trainer object such as the svm_nu_trainer or rbf_network_trainer. This function does the same thing as cross_validate_trainer except this function also allows you to specify how many threads of execution to use. So you can use this function to take advantage of a multi-core system to perform cross validation faster.

Specification: dlib/svm/svm_threaded_abstract.h
File to include: dlib/svm_threaded.h

[top]

decision_function

This object represents a decision or regression function that was learned by a kernel based learning algorithm.

Specification: dlib/svm/function_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

discriminant_pca

This object implements the Discriminant PCA technique described in the paper:

A New Discriminant Principal Component Analysis Method with Partial Supervision (2009) by Dan Sun and Daoqiang Zhang

This algorithm is basically a straightforward generalization of the classical PCA technique to handle partially labeled data. It is useful if you want to learn a linear dimensionality reduction rule using a bunch of data that is partially labeled.

Specification: dlib/statistics/dpca_abstract.h
File to include: dlib/statistics.h

[top]

distance_function

This object represents a point in kernel induced feature space. You may use this object to find the distance from the point it represents to points in input space as well as other points represented by distance_functions.

Specification: dlib/svm/function_abstract.h
File to include: dlib/svm.h

[top]

empirical_kernel_map

This object represents a map from objects of sample_type (the kind of object a kernel function operates on) to finite dimensional column vectors which represent points in the kernel feature space defined by whatever kernel is used with this object.

To use the empirical_kernel_map you supply it with a particular kernel and a set of basis samples. After that you can present it with new samples and it will project them into the part of kernel feature space spanned by your basis samples.

This means the empirical_kernel_map is a tool you can use to very easily kernelize any algorithm that operates on column vectors. All you have to do is select a set of basis samples and then use the empirical_kernel_map to project all your data points into the part of kernel feature space spanned by those basis samples. Then just run your normal algorithm on the output vectors and it will be effectively kernelized.

Regarding methods to select a set of basis samples, if you are working with only a few thousand samples then you can just use all of them as basis samples. Alternatively, the linearly_independent_subset_finder often works well for selecting a basis set. Some people also find that picking a random subset works fine.

Specification: dlib/svm/empirical_kernel_map_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

find_clusters_using_kmeans

This is just a simple linear kmeans clustering implementation.

Specification: dlib/svm/kkmeans_abstract.h
File to include: dlib/svm.h

[top]

find_gamma_with_big_centroid_gap

This is a function that tries to pick a reasonable default value for the gamma parameter of the radial_basis_kernel. It picks the parameter that gives the largest separation between the centroids, in kernel feature space, of two classes of data.

Specification: dlib/svm/feature_ranking_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

is_binary_classification_problem

This function simply takes two vectors, the first containing feature vectors and the second containing labels, and reports back if the two could possibly contain data for a well formed classification problem.

Specification: dlib/svm/svm_abstract.h
File to include: dlib/svm.h

[top]

kcentroid

This object represents a weighted sum of sample points in a kernel induced feature space. It can be used to kernelize any algorithm that requires only the ability to perform vector addition, subtraction, scalar multiplication, and inner products.

An example use of this object is as an online algorithm for recursively estimating the centroid of a sequence of training points. This object then allows you to compute the distance between the centroid and any test points. So you can use this object to predict how similar a test point is to the data this object has been trained on (larger distances from the centroid indicate dissimilarity/anomalous points).

The object internally keeps a set of "dictionary vectors" that are used to represent the centroid. It manages these vectors using the sparsification technique described in the paper The Kernel Recursive Least Squares Algorithm by Yaakov Engel. This technique allows us to keep the number of dictionary vectors down to a minimum. In fact, the object has a user selectable tolerance parameter that controls the trade off between accuracy and number of stored dictionary vectors.

Specification: dlib/svm/kcentroid_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

kernel_matrix

This is a simple set of functions that makes it easy to turn a kernel object and a set of samples into a kernel matrix. It takes these two things and returns a matrix expression that represents the kernel matrix.

Specification: dlib/svm/kernel_matrix_abstract.h
File to include: dlib/svm.h

[top]

kkmeans

This is an implementation of a kernelized k-means clustering algorithm. It performs k-means clustering by using the kcentroid object.

Specification: dlib/svm/kkmeans_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

krls

This is an implementation of the kernel recursive least squares algorithm described in the paper The Kernel Recursive Least Squares Algorithm by Yaakov Engel.

The long and short of this algorithm is that it is an online kernel based regression algorithm. You give it samples (x,y) and it learns the function f(x) == y. For a detailed description of the algorithm read the above paper.

Specification: dlib/svm/krls_abstract.h
File to include: dlib/svm.h
Code Examples: 1, 2

[top]

linearly_independent_subset_finder

This is an implementation of an online algorithm for recursively finding a set of linearly independent vectors in a kernel induced feature space. To use it you decide how large you would like the set to be and then you feed it sample points.

Each time you present it with a new sample point it either keeps the current set of independent points unchanged, or if the new point is "more linearly independent" than one of the points it already has, it replaces the weakly linearly independent point with the new one.

This object uses the Approximately Linearly Dependent metric described in the paper The Kernel Recursive Least Squares Algorithm by Yaakov Engel to decide which points are more linearly independent than others.

Specification: dlib/svm/linearly_independent_subset_finder_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

linear_kernel

This object represents a linear function kernel for use with kernel learning machines.

Specification: dlib/svm/kernel_abstract.h
File to include: dlib/svm.h

[top]

load_libsvm_formatted_data

This is a function that loads the data from a file that uses the LIBSVM format. It loads the data into a std::vector of sparse vectors. If you want to load data into dense vectors (i.e. dlib::matrix objects) then you can use the sparse_to_dense function to perform the conversion.

Specification: dlib/data_io/libsvm_io_abstract.h
File to include: dlib/data_io.h

[top]

mlp

This object represents a multilayer layer perceptron network that is trained using the back propagation algorithm. The training algorithm also incorporates the momentum method. That is, each round of back propagation training also adds a fraction of the previous update. This fraction is controlled by the momentum term set in the constructor.

It is worth noting that a MLP is, in general, very inferior to modern kernel algorithms such as the support vector machine. So if you haven't tried any other techniques with your data you really should.

Specification: dlib/mlp/mlp_kernel_abstract.h
File to include: dlib/mlp.h
Code Examples: 1

Implementations:

mlp_kernel_1:
This is implemented in the obvious way.

kernel_1a	is a typedef for mlp_kernel_1
kernel_1a_c	is a typedef for kernel_1a that checks its preconditions.

[top]

normalized_function

This object represents a container for another function object and an instance of the vector_normalizer object. It automatically normalizes all inputs before passing them off to the contained function object.

Specification: dlib/svm/function_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

null_trainer

This is a convenience function for creating null_trainer_type objects.

Specification: dlib/svm/null_trainer_abstract.h
File to include: dlib/svm.h

[top]

null_trainer_type

This object is a simple tool for turning a decision_function (or any object with an interface compatible with decision_function) into a trainer object that always returns the original decision function when you try to train with it.

dlib contains a few "training post processing" algorithms (e.g. reduced and reduced2). These tools take in a trainer object, tell it to perform training, and then they take the output decision function and do some kind of post processing to it. The null_trainer_type object is useful because you can use it to run an already learned decision function through the training post processing algorithms by turning a decision function into a null_trainer_type and then giving it to a post processor.

Specification: dlib/svm/null_trainer_abstract.h
File to include: dlib/svm.h

[top]

offset_kernel

This object represents a kernel with a fixed value offset added to it.

Specification: dlib/svm/kernel_abstract.h
File to include: dlib/svm.h

[top]

pick_initial_centers

This is a function that you can use to seed data clustering algorithms like the kkmeans clustering method. What it does is pick reasonable starting points for clustering by basically trying to find a set of points that are all far away from each other.

Specification: dlib/svm/kkmeans_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

polynomial_kernel

This object represents a polynomial kernel for use with kernel learning machines.

Specification: dlib/svm/kernel_abstract.h
File to include: dlib/svm.h

[top]

probabilistic_decision_function

This object represents a binary decision function for use with kernel-based learning-machines. It returns an estimate of the probability that a given sample is in the +1 class.

Specification: dlib/svm/function_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

projection_function

This object represents a function that takes a data sample and projects it into kernel feature space. The result is a real valued column vector that represents a point in a kernel feature space. Instances of this object are created using the empirical_kernel_map.

Specification: dlib/svm/function_abstract.h
File to include: dlib/svm.h

[top]

radial_basis_kernel

This object represents a radial basis function kernel for use with kernel learning machines.

Specification: dlib/svm/kernel_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

randomize_samples

Randomizes the order of samples in a column vector containing sample data.

Specification: dlib/svm/svm_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

rank_features

Finds a ranking of the top N (a user supplied parameter) features in a set of data from a two class classification problem. It does this by computing the distance between the centroids of both classes in kernel defined feature space. Good features are then ones that result in the biggest separation between the two centroids.

Specification: dlib/svm/feature_ranking_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

rbf_network_trainer

Trains a radial basis function network and outputs a decision_function.

Specification: dlib/svm/rbf_network_abstract.h
File to include: dlib/svm.h

[top]

reduced

This is a convenience function for creating reduced_decision_function_trainer objects.

Specification: dlib/svm/reduced_abstract.h
File to include: dlib/svm.h

[top]

reduced2

This is a convenience function for creating reduced_decision_function_trainer2 objects.

Specification: dlib/svm/reduced_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

reduced_decision_function_trainer

This is a batch trainer object that is meant to wrap other batch trainer objects that create decision_function objects. It performs post processing on the output decision_function objects with the intent of representing the decision_function with fewer basis vectors.

Specification: dlib/svm/reduced_abstract.h
File to include: dlib/svm.h

[top]

reduced_decision_function_trainer2

This is a batch trainer object that is meant to wrap other batch trainer objects that create decision_function objects. It performs post processing on the output decision_function objects with the intent of representing the decision_function with fewer basis vectors.

It begins by performing the same post processing as the reduced_decision_function_trainer object but it also performs a global gradient based optimization to further improve the results.

Specification: dlib/svm/reduced_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

roc_c1_trainer

This is a convenience function for creating roc_trainer_type objects that are setup to pick a point on the ROC curve with respect to the +1 class.

Specification: dlib/svm/roc_trainer_abstract.h
File to include: dlib/svm.h

[top]

roc_c2_trainer

This is a convenience function for creating roc_trainer_type objects that are setup to pick a point on the ROC curve with respect to the -1 class.

Specification: dlib/svm/roc_trainer_abstract.h
File to include: dlib/svm.h

[top]

roc_trainer_type

This object is a simple trainer post processor that allows you to easily adjust the bias term in a trained decision_function object. That is, this object lets you pick a point on the ROC curve and it will adjust the bias term appropriately.

So for example, suppose you wanted to set the bias term so that the accuracy of your decision function on +1 labeled samples was 99%. To do this you would use an instance of this object declared as follows: roc_trainer_type<trainer_type>(your_trainer, 0.99, +1);

Specification: dlib/svm/roc_trainer_abstract.h
File to include: dlib/svm.h

[top]

rvm_regression_trainer

Trains a relevance vector machine for solving regression problems. Outputs a decision_function that represents the learned regression function.

The implementation of the RVM training algorithm used by this library is based on the following paper:

Tipping, M. E. and A. C. Faul (2003). Fast marginal likelihood maximisation for sparse Bayesian models. In C. M. Bishop and B. J. Frey (Eds.), Proceedings of the Ninth International Workshop on Artificial Intelligence and Statistics, Key West, FL, Jan 3-6.

Specification: dlib/svm/rvm_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

rvm_trainer

Trains a relevance vector machine for solving binary classification problems. Outputs a decision_function that represents the learned classifier.

The implementation of the RVM training algorithm used by this library is based on the following paper:

Tipping, M. E. and A. C. Faul (2003). Fast marginal likelihood maximisation for sparse Bayesian models. In C. M. Bishop and B. J. Frey (Eds.), Proceedings of the Ninth International Workshop on Artificial Intelligence and Statistics, Key West, FL, Jan 3-6.

Specification: dlib/svm/rvm_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

save_libsvm_formatted_data

This is actually a pair of overloaded functions. Between the two of them they let you save sparse or dense data vectors to file using the LIBSVM format.

Specification: dlib/data_io/libsvm_io_abstract.h
File to include: dlib/data_io.h

[top]

sigmoid_kernel

This object represents a sigmoid kernel for use with kernel learning machines.

Specification: dlib/svm/kernel_abstract.h
File to include: dlib/svm.h

[top]

sparse_linear_kernel

This object represents a linear function kernel for use with kernel learning machines that operate on sparse vectors.

Specification: dlib/svm/sparse_kernel_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

sparse_polynomial_kernel

This object represents a polynomial kernel for use with kernel learning machines that operate sparse vectors.

Specification: dlib/svm/sparse_kernel_abstract.h
File to include: dlib/svm.h

[top]

sparse_radial_basis_kernel

This object represents a radial basis function kernel for use with kernel learning machines that operate sparse vectors.

Specification: dlib/svm/sparse_kernel_abstract.h
File to include: dlib/svm.h

[top]

sparse_sigmoid_kernel

This object represents a sigmoid kernel for use with kernel learning machines that operate on sparse vectors.

Specification: dlib/svm/sparse_kernel_abstract.h
File to include: dlib/svm.h

[top]

sparse_to_dense

This is a simple function that takes a std::vector of sparse vectors and returns to you the equivalent std::vector of dense vectors.

Specification: dlib/data_io/libsvm_io_abstract.h
File to include: dlib/data_io.h

[top]

svm_c_linear_trainer

This object represents a tool for training the C formulation of a support vector machine and is optimized for the case where linear kernels are used. It is implemented using the oca optimizer and uses the exact line search described in the following paper:

Optimized Cutting Plane Algorithm for Large-Scale Risk Minimization by Vojtech Franc, Soren Sonnenburg; Journal of Machine Learning Research, 10(Oct):2157--2192, 2009.

Specification: dlib/svm/svm_c_linear_trainer_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

svm_nu_trainer

Trains a nu support vector classifier and outputs a decision_function.

The implementation of the nu-svm training algorithm used by this library is based on the following excellent papers:

• Chang and Lin, Training {nu}-Support Vector Classifiers: Theory and Algorithms
• Chih-Chung Chang and Chih-Jen Lin, LIBSVM : a library for support vector machines, 2001. Software available at http://www.csie.ntu.edu.tw/~cjlin/libsvm

Specification: dlib/svm/svm_abstract.h
File to include: dlib/svm.h
Code Examples: 1, 2

[top]

svm_pegasos

This object implements an online algorithm for training a support vector machine for solving binary classification problems.

The implementation of the Pegasos algorithm used by this object is based on the following excellent paper:

Pegasos: Primal estimated sub-gradient solver for SVM (2007) by Shai Shalev-Shwartz, Yoram Singer, Nathan Srebro In ICML

This SVM training algorithm has two interesting properties. First, the pegasos algorithm itself converges to the solution in an amount of time unrelated to the size of the training set (in addition to being quite fast to begin with). This makes it an appropriate algorithm for learning from very large datasets. Second, this object uses the kcentroid object to maintain a sparse approximation of the learned decision function. This means that the number of support vectors in the resulting decision function is also unrelated to the size of the dataset (in normal SVM training algorithms, the number of support vectors grows approximately linearly with the size of the training set).

Specification: dlib/svm/pegasos_abstract.h
File to include: dlib/svm.h
Code Examples: 1, 2

[top]

test_binary_decision_function

Tests a decision_function that represents a binary decision function and returns the test accuracy.

Specification: dlib/svm/svm_abstract.h
File to include: dlib/svm.h

[top]

train_probabilistic_decision_function

Trains a probabilistic_decision_function using some sort of batch trainer object such as the svm_nu_trainer or rbf_network_trainer.

The probability model is created by using the technique described in the paper:

Probabilistic Outputs for Support Vector Machines and Comparisons to Regularized Likelihood Methods by John C. Platt. March 26, 1999

Specification: dlib/svm/svm_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

vector_normalizer

This object represents something that can learn to normalize a set of column vectors. In particular, normalized column vectors should have zero mean and a variance of one.

Specification: dlib/statistics/statistics_abstract.h
File to include: dlib/statistics.h
Code Examples: 1

[top]

vector_normalizer_pca

This object represents something that can learn to normalize a set of column vectors. In particular, normalized column vectors should have zero mean and a variance of one. This object also uses principal component analysis for the purposes of reducing the number of elements in a vector.

Specification: dlib/statistics/statistics_abstract.h
File to include: dlib/statistics.h

[top]

verbose_batch

This is a convenience function for creating batch_trainer objects. This function generates a batch_trainer that will print status messages to standard output so that you can observe the progress of a training algorithm.

Specification: dlib/svm/pegasos_abstract.h
File to include: dlib/svm.h
Code Examples: 1

[top]

verbose_batch_cached

This is a convenience function for creating batch_trainer objects. This function generates a batch_trainer that will print status messages to standard output so that you can observe the progress of a training algorithm. It will also be configured to use a kernel matrix cache.

Specification: dlib/svm/pegasos_abstract.h
File to include: dlib/svm.h