# Machine Learning

Dlib contains a wide range of machine learning algorithms. All designed to be highly modular, quick to execute, and simple to use via a clean and modern C++ API. It is used in a wide range of applications including robotics, embedded devices, mobile phones, and large high performance computing environments. If you use dlib in your research please cite:

    Davis E. King. Dlib-ml: A Machine Learning Toolkit.
       Journal of Machine Learning Research, 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},
    }

## Primary Algorithms

Binary Classification
svm_nu_trainer
svm_c_trainer
svm_c_linear_trainer
svm_c_linear_dcd_trainer
svm_c_ekm_trainer
rvm_trainer
svm_pegasos
train_probabilistic_decision_function
Multiclass Classification
one_vs_one_trainer
one_vs_all_trainer
svm_multiclass_linear_trainer
Regression
mlp
krls
rls
krr_trainer
rr_trainer
svr_trainer
svr_linear_trainer
rvm_regression_trainer
rbf_network_trainer
Structured Prediction
Problem Instances
structural_svm_sequence_labeling_problem structural_svm_object_detection_problem structural_svm_assignment_problem structural_svm_graph_labeling_problem
Core Tools
structural_svm_problem structural_svm_problem_threaded svm_struct_controller_node svm_struct_processing_node
structural_object_detection_trainer
structural_sequence_labeling_trainer
structural_sequence_segmentation_trainer
structural_assignment_trainer
structural_track_association_trainer
structural_graph_labeling_trainer
svm_rank_trainer
shape_predictor_trainer
Deep Learning
Core Tools
add_layer add_loss_layer repeat add_tag_layer add_skip_layer layer test_layer resizable_tensor alias_tensor
Input Layers
input input_rgb_image input_rgb_image_sized EXAMPLE_INPUT_LAYER dlib/dnn/input_abstract.h.html#EXAMPLE_INPUT_LAYER
Computational Layers
EXAMPLE_COMPUTATIONAL_LAYER dlib/dnn/layers_abstract.h.html#EXAMPLE_COMPUTATIONAL_LAYER_ fc dlib/dnn/layers_abstract.h.html#fc_ con dlib/dnn/layers_abstract.h.html#con_ dropout dlib/dnn/layers_abstract.h.html#dropout_ multiply dlib/dnn/layers_abstract.h.html#multiply_ bn dlib/dnn/layers_abstract.h.html#bn_ affine dlib/dnn/layers_abstract.h.html#affine_ max_pool dlib/dnn/layers_abstract.h.html#max_pool_ avg_pool dlib/dnn/layers_abstract.h.html#avg_pool_ relu dlib/dnn/layers_abstract.h.html#relu_ concat dlib/dnn/layers_abstract.h.html#concat_ prelu dlib/dnn/layers_abstract.h.html#prelu_ sig dlib/dnn/layers_abstract.h.html#sig_ htan dlib/dnn/layers_abstract.h.html#htan_ softmax dlib/dnn/layers_abstract.h.html#softmax_ add_prev dlib/dnn/layers_abstract.h.html#add_prev_ inception dlib/dnn/layers_abstract.h.html#inception
Loss Layers
EXAMPLE_LOSS_LAYER dlib/dnn/loss_abstract.h.html#EXAMPLE_LOSS_LAYER_ loss_binary_hinge dlib/dnn/loss_abstract.h.html#loss_binary_hinge_ loss_binary_log dlib/dnn/loss_abstract.h.html#loss_binary_log_ loss_multiclass_log dlib/dnn/loss_abstract.h.html#loss_multiclass_log_
Solvers
EXAMPLE_SOLVER dlib/dnn/solvers_abstract.h.html#EXAMPLE_SOLVER sgd dlib/dnn/solvers_abstract.h.html#sgd adam dlib/dnn/solvers_abstract.h.html#adam
Clustering
pick_initial_centers
kkmeans
find_clusters_using_kmeans
find_clusters_using_angular_kmeans
nearest_center
newman_cluster
spectral_cluster
chinese_whispers
bottom_up_cluster
modularity
Unsupervised
kcentroid
linearly_independent_subset_finder
empirical_kernel_map
svm_one_class_trainer
vector_normalizer
vector_normalizer_pca
sammon_projection
cca
Semi-Supervised/Metric Learning
linear_manifold_regularizer
discriminant_pca
vector_normalizer_frobmetric
compute_lda_transform
Reinforcement Learning
lspi
Feature Selection
rank_features
sort_basis_vectors
rank_unlabeled_training_samples

## Other Tools

Validation
cross_validate_trainer
cross_validate_object_detection_trainer
cross_validate_trainer_threaded
cross_validate_multiclass_trainer
cross_validate_regression_trainer
cross_validate_sequence_labeler
cross_validate_sequence_segmenter
cross_validate_assignment_trainer
cross_validate_track_association_trainer
cross_validate_graph_labeling_trainer
cross_validate_ranking_trainer
test_binary_decision_function
test_multiclass_decision_function
test_regression_function
test_object_detection_function
test_sequence_labeler
test_sequence_segmenter
test_assignment_function
test_track_association_function
test_graph_labeling_function
test_ranking_function
test_shape_predictor
average_precision
equal_error_rate
Trainer Adapters
reduced
reduced2
batch
probabilistic
verbose_batch
batch_cached
verbose_batch_cached
null_trainer
roc_c1_trainer
roc_c2_trainer
Kernels
radial_basis_kernel
polynomial_kernel
sigmoid_kernel
linear_kernel
histogram_intersection_kernel
offset_kernel
sparse_radial_basis_kernel
sparse_polynomial_kernel
sparse_sigmoid_kernel
sparse_linear_kernel
sparse_histogram_intersection_kernel
Function Objects
decision_function
projection_function
distance_function
probabilistic_decision_function
probabilistic_function
normalized_function
one_vs_one_decision_function
multiclass_linear_decision_function
one_vs_all_decision_function
sequence_labeler
sequence_segmenter
assignment_function
track_association_function
graph_labeler
policy
Data IO
load_image_dataset_metadata
load_image_dataset
save_image_dataset_metadata
load_libsvm_formatted_data
save_libsvm_formatted_data
fix_nonzero_indexing
Miscellaneous
simplify_linear_decision_function
fill_lisf
randomize_samples
is_binary_classification_problem
is_sequence_labeling_problem
is_sequence_segmentation_problem
is_graph_labeling_problem
is_assignment_problem
is_track_association_problem
is_forced_assignment_problem
approximate_distance_function
is_learning_problem
select_all_distinct_labels
find_gamma_with_big_centroid_gap
compute_mean_squared_distance
kernel_matrix
ranking_pair
is_ranking_problem
count_ranking_inversions
learn_platt_scaling
process_sample
add_layer
dlib/dnn.h
dlib/dnn/core_abstract.h
In dlib, a deep neural network is composed of 3 main parts. An input layer, a bunch of computational layers, and optionally a loss layer. The add_layer class is the central object which adds a computational layer onto an input layer or an entire network. Therefore, deep neural networks are created by stacking many layers on top of each other using the add_layer class.

For a tutorial showing how this is accomplished read the DNN Introduction part 1 and DNN Introduction part 2.

dnn_introduction_ex.cpp.html
dnn_introduction2_ex.cpp.html
dnn_inception_ex.cpp.html
dnn_imagenet_ex.cpp.html
dnn_imagenet_train_ex.cpp.html
add_loss_layer
dlib/dnn.h
dlib/dnn/core_abstract.h
This object is a tool for stacking a loss layer on the top of a deep neural network.
dnn_introduction_ex.cpp.html
dnn_introduction2_ex.cpp.html
dnn_inception_ex.cpp.html
dnn_imagenet_ex.cpp.html
dnn_imagenet_train_ex.cpp.html
repeat
dlib/dnn.h
dlib/dnn/core_abstract.h
This object adds N copies of a computational layer onto a deep neural network. It is essentially the same as using add_layer N times, except that it involves less typing, and for large N, will compile much faster.
dnn_introduction2_ex.cpp.html
add_tag_layer
dlib/dnn.h
dlib/dnn/core_abstract.h
This object is a tool for tagging layers in a deep neural network. These tags make it easy to refer to the tagged layer in other parts of your code. Specifically, this object adds a new layer onto a deep neural network. However, this layer simply performs the identity transform. This means it is a no-op and its presence does not change the behavior of the network. It exists solely to be used by add_skip_layer or layer() to reference a particular part of a network.

For a tutorial showing how to use tagging see the dnn_introduction2_ex.cpp example program.

dnn_introduction2_ex.cpp.html
add_skip_layer
dlib/dnn.h
dlib/dnn/core_abstract.h
This object adds a new layer to a deep neural network which draws its input from a tagged layer rather than from the immediate predecessor layer as is normally done.

For a tutorial showing how to use tagging see the dnn_introduction2_ex.cpp example program.

layer
dlib/dnn.h
dlib/dnn/core_abstract.h
This global function references a tagged layer inside a deep neural network object.

For a tutorial showing how to use tagging see the dnn_introduction2_ex.cpp example program.

dnn_introduction2_ex.cpp.html
input
dlib/dnn.h
dlib/dnn/input_abstract.h
This is a simple input layer type for use in a deep neural network which takes some kind of image as input and loads it into a network.
dnn_introduction_ex.cpp.html
dnn_introduction2_ex.cpp.html
dnn_inception_ex.cpp.html
dnn_imagenet_ex.cpp.html
dnn_imagenet_train_ex.cpp.html
input_rgb_image
dlib/dnn.h
dlib/dnn/input_abstract.h
This is a simple input layer type for use in a deep neural network which takes an RGB image as input and loads it into a network. It is very similar to the input layer except that it allows you to subtract the average color value from each color channel when converting an image to a tensor.
input_rgb_image_sized
dlib/dnn.h
dlib/dnn/input_abstract.h
This layer has an interface and behavior identical to input_rgb_image except that it requires input images to have a particular size.
test_layer
dlib/dnn.h
dlib/dnn/core_abstract.h
This is a function which tests if a layer object correctly implements the documented contract for a computational layer in a deep neural network.
resizable_tensor
dlib/dnn.h
dlib/dnn/tensor_abstract.h
This object represents a 4D array of float values, all stored contiguously in memory. Importantly, it keeps two copies of the floats, one on the host CPU side and another on the GPU device side. It automatically performs the necessary host/device transfers to keep these two copies of the data in sync.

All transfers to the device happen asynchronously with respect to the default CUDA stream so that CUDA kernel computations can overlap with data transfers. However, any transfers from the device to the host happen synchronously in the default CUDA stream. Therefore, you should perform all your CUDA kernel launches on the default stream so that transfers back to the host do not happen before the relevant computations have completed.

If DLIB_USE_CUDA is not #defined then this object will not use CUDA at all. Instead, it will simply store one host side memory block of floats.

Finally, the convention in dlib code is to interpret the tensor as a set of num_samples() 3D arrays, each of dimension k() by nr() by nc(). Also, while this class does not specify a memory layout, the convention is to assume that indexing into an element at coordinates (sample,k,nr,nc) can be accomplished via: host()[((sample*t.k() + k)*t.nr() + nr)*t.nc() + nc]

alias_tensor
dlib/dnn.h
dlib/dnn/tensor_abstract.h
This object is a tensor that aliases another tensor. That is, it doesn't have its own block of memory but instead simply holds pointers to the memory of another tensor object. It therefore allows you to efficiently break a tensor into pieces and pass those pieces into functions.
modularity
dlib/clustering.h
dlib/clustering/modularity_clustering_abstract.h
This function computes the modularity of a particular graph clustering. This is a number that tells you how good the clustering is. In particular, it is the measure optimized by the newman_cluster routine.
newman_cluster
dlib/clustering.h
dlib/clustering/modularity_clustering_abstract.h
This function performs the clustering algorithm described in the paper

> Modularity and community structure in networks by M. E. J. Newman.

In particular, this is a method for automatically clustering the nodes in a graph into groups. The method is able to automatically determine the number of clusters and does not have any parameters. In general, it is a very good clustering technique.
spectral_cluster
dlib/clustering.h
dlib/clustering/spectral_cluster_abstract.h
This function performs the clustering algorithm described in the paper

> On spectral clustering: Analysis and an algorithm by Ng, Jordan, and Weiss.

kkmeans_ex.cpp.html
bottom_up_cluster
dlib/clustering.h
dlib/clustering/bottom_up_cluster_abstract.h
This function runs a bottom up agglomerative clustering algorithm.
chinese_whispers
dlib/clustering.h
dlib/clustering/chinese_whispers_abstract.h
This function performs the clustering algorithm described in the paper

> Chinese Whispers - an Efficient Graph Clustering Algorithm and its Application to Natural Language Processing Problems by Chris Biemann.

In particular, this is a method for automatically clustering the nodes in a graph into groups. The method is able to automatically determine the number of clusters.
find_clusters_using_kmeans
dlib/clustering.h
dlib/svm/kkmeans_abstract.h
This is a simple linear kmeans clustering implementation. It uses Euclidean distance to compare samples.
find_clusters_using_angular_kmeans
dlib/clustering.h
dlib/svm/kkmeans_abstract.h
This is a simple linear kmeans clustering implementation. To compare a sample to a cluster, it measures the angle between them with respect to the origin. Therefore, it tries to find clusters of points that all have small angles between each cluster member.
nearest_center
dlib/clustering.h
dlib/svm/kkmeans_abstract.h
This function takes a list of cluster centers and a query vector and identifies which cluster center is nearest to the query vector.
pick_initial_centers
dlib/clustering.h
dlib/svm/kkmeans_abstract.h
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.
kkmeans_ex.cpp.html
ranking_pair
dlib/svm.h
dlib/svm/ranking_tools_abstract.h
This object is used to contain a ranking example. Therefore, ranking_pair objects are used to represent training examples for learning-to-rank tasks, such as those used by the svm_rank_trainer.
svm_rank_ex.cpp.html
svm_rank.py.html
kernel_matrix
dlib/svm.h
dlib/svm/kernel_matrix_abstract.h
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.
is_ranking_problem
dlib/svm.h
dlib/svm/ranking_tools_abstract.h
This function takes a set of training data for a learning-to-rank problem and reports back if it could possibly be a well formed problem.
count_ranking_inversions
dlib/svm.h
dlib/svm/ranking_tools_abstract.h
Given two sets of objects, X and Y, and an ordering relationship defined between their elements, this function counts how many times we see an element in the set Y ordered before an element in the set X. Additionally, this routine executes efficiently in O(n*log(n)) time via the use of quick sort.
mlp
dlib/mlp.h
dlib/mlp/mlp_kernel_abstract.h

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.

mlp_ex.cpp.html
mlp_kernel_1
dlib/mlp/mlp_kernel_1.h
This is implemented in the obvious way.
kernel_1a
is a typedef for mlp_kernel_1
krls
dlib/svm.h
dlib/svm/krls_abstract.h
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.

Note that if you want to use the linear kernel then you would be better off using the rls object as it is optimized for this case.

krls_ex.cpp.html
krls_filter_ex.cpp.html
rls
dlib/svm.h
dlib/svm/rls_abstract.h
This is an implementation of the linear version of the recursive least squares algorithm. It accepts training points incrementally and, at each step, maintains the solution to the following optimization problem:

> find w minimizing: 0.5*dot(w,w) + C*sum_i(y_i - trans(x_i)*w)^2

Where (x_i,y_i) are training pairs. x_i is some vector and y_i is a target scalar value.
svm_pegasos
dlib/svm.h
dlib/svm/pegasos_abstract.h
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).

However, if you are considering using svm_pegasos, you should also try the svm_c_linear_trainer for linear kernels or svm_c_ekm_trainer for non-linear kernels since these other trainers are, usually, faster and easier to use than svm_pegasos.

svm_pegasos_ex.cpp.html
svm_sparse_ex.cpp.html
kkmeans
dlib/clustering.h
dlib/svm/kkmeans_abstract.h
This is an implementation of a kernelized k-means clustering algorithm. It performs k-means clustering by using the kcentroid object.

If you want to use the linear kernel (i.e. do a normal k-means clustering) then you should use the find_clusters_using_kmeans routine.

kkmeans_ex.cpp.html
vector_normalizer
dlib/statistics.h
dlib/statistics/statistics_abstract.h
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.
svm_ex.cpp.html
vector_normalizer_frobmetric
dlib/statistics.h
dlib/statistics/vector_normalizer_frobmetric_abstract.h
This object is a tool for performing the FrobMetric distance metric learning algorithm described in the following paper:

> A Scalable Dual Approach to Semidefinite Metric Learning By Chunhua Shen, Junae Kim, Lei Wang, in CVPR 2011

Therefore, this object is a tool that takes as input training triplets (anchor, near, far) of vectors and attempts to learn a linear transformation T such that:

> length(T*anchor-T*near) + 1 < length(T*anchor - T*far)

That is, you give a bunch of anchor vectors and for each anchor vector you specify some vectors which should be near to it and some that should be far form it. This object then tries to find a transformation matrix that makes the "near" vectors close to their anchors while the "far" vectors are farther away.
compute_lda_transform
dlib/statistics.h
dlib/statistics/lda_abstract.h
This function performs the dimensionality reducing version of linear discriminant analysis. That is, you give it a set of labeled vectors and it returns a linear transform that maps the input vectors into a new space that is good for distinguishing between the different classes.
discriminant_pca
dlib/statistics.h
dlib/statistics/dpca_abstract.h
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.
sammon_projection
dlib/statistics.h
dlib/statistics/sammon_abstract.h
This is a function object that computes the Sammon projection of a set of N points in a L-dimensional vector space onto a d-dimensional space (d < L), according to the paper:

> A Nonlinear Mapping for Data Structure Analysis (1969) by J.W. Sammon

cca
dlib/statistics.h
dlib/statistics/cca_abstract.h
This function performs a canonical correlation analysis between two sets of vectors. Additionally, it is designed to be very fast, even for large datasets of over a million high dimensional vectors.
vector_normalizer_pca
dlib/statistics.h
dlib/statistics/statistics_abstract.h
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.
linearly_independent_subset_finder
dlib/svm.h
dlib/svm/linearly_independent_subset_finder_abstract.h

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

The implementation 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. The metric is simply the squared distance between a test point and the subspace spanned by the set of dictionary vectors.

Each time you present this object with a new sample point it calculates the projection distance and if it is sufficiently large then this new point is included into the dictionary. Note that this object can be configured to have a maximum size. Once the max dictionary size is reached each new point kicks out a previous point. This is done by removing the dictionary vector that has the smallest projection distance onto the others. That is, the "least linearly independent" vector is removed to make room for the new one.

empirical_kernel_map_ex.cpp.html
fill_lisf
dlib/svm.h
dlib/svm/linearly_independent_subset_finder_abstract.h
This is a simple function for filling a linearly_independent_subset_finder with data points by using random sampling.
empirical_kernel_map_ex.cpp.html
sort_basis_vectors
dlib/svm.h
dlib/svm/sort_basis_vectors_abstract.h
A kernel based learning method ultimately needs to select a set of basis functions represented by a particular choice of kernel and a set of basis vectors. sort_basis_vectors() is a function which attempts to perform supervised basis set selection. In particular, you give it a candidate set of basis vectors and it sorts them according to how useful they are for solving a particular decision problem.
rank_unlabeled_training_samples
dlib/svm.h
dlib/svm/active_learning_abstract.h
This routine implements an active learning method for selecting the most informative data sample to label out of a set of unlabeled samples. In particular, it implements the MaxMin Margin and Ratio Margin methods described in the paper:

> Support Vector Machine Active Learning with Applications to Text Classification by Simon Tong and Daphne Koller.

linear_manifold_regularizer
dlib/manifold_regularization.h
dlib/manifold_regularization/linear_manifold_regularizer_abstract.h

Many learning algorithms attempt to minimize a function that, at a high level, looks like this:

       f(w) == complexity + training_set_error

The idea is to find the set of parameters, w, that gives low error on your training data but also is not "complex" according to some particular measure of complexity. This strategy of penalizing complexity is usually called regularization.

In the above setting, all the training data consists of labeled samples. However, it would be nice to be able to benefit from unlabeled data. The idea of manifold regularization is to extract useful information from unlabeled data by first defining which data samples are "close" to each other (perhaps by using their 3 nearest neighbors) and then adding a term to the above function that penalizes any decision rule which produces different outputs on data samples which we have designated as being close.

It turns out that it is possible to transform these manifold regularized learning problems into the normal form shown above by applying a certain kind of preprocessing to all our data samples. Once this is done we can use a normal learning algorithm, such as the svm_c_linear_trainer, on just the labeled data samples and obtain the same output as the manifold regularized learner would have produced.

The linear_manifold_regularizer is a tool for creating this preprocessing transformation. In particular, the transformation is linear. That is, it is just a matrix you multiply with all your samples. For a more detailed discussion of this topic you should consult the following paper. In particular, see section 4.2. This object computes the inverse T matrix described in that section.

> Linear Manifold Regularization for Large Scale Semi-supervised Learning by Vikas Sindhwani, Partha Niyogi, and Mikhail Belkin

linear_manifold_regularizer_ex.cpp.html
empirical_kernel_map
dlib/svm.h
dlib/svm/empirical_kernel_map_abstract.h

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. I also find that picking a random subset typically works well.

empirical_kernel_map_ex.cpp.html
linear_manifold_regularizer_ex.cpp.html
kcentroid
dlib/svm.h
dlib/svm/kcentroid_abstract.h

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.

kcentroid_ex.cpp.html
train_probabilistic_decision_function
dlib/svm.h
dlib/svm/svm_abstract.h

Trains a probabilistic_function using some sort of binary classification trainer object such as the svm_nu_trainer or krr_trainer.

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

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

> A Note on Platt's Probabilistic Outputs for Support Vector Machines by Hsuan-Tien Lin, Chih-Jen Lin, and Ruby C. Weng

svm_ex.cpp.html
learn_platt_scaling
dlib/svm.h
dlib/svm/svm_abstract.h

This function is an implementation of the algorithm described in the following papers:

> Probabilistic Outputs for Support Vector Machines and Comparisons to Regularized Likelihood Methods by John C. Platt. March 26, 1999
> A Note on Platt's Probabilistic Outputs for Support Vector Machines by Hsuan-Tien Lin, Chih-Jen Lin, and Ruby C. Weng

This function is the tool used to implement the train_probabilistic_decision_function routine.

probabilistic
dlib/svm.h
dlib/svm/svm_abstract.h
This is a trainer adapter which simply runs the trainer it is given though the train_probabilistic_decision_function function.
rbf_network_trainer
dlib/svm.h
dlib/svm/rbf_network_abstract.h
Trains a radial basis function network and outputs a decision_function. This object can be used for either regression or binary classification problems. It's worth pointing out that this object is essentially an unregularized version of kernel ridge regression. This means you should really prefer to use kernel ridge regression instead.
rvm_regression_trainer
dlib/svm.h
dlib/svm/rvm_abstract.h

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.

rvm_regression_ex.cpp.html
rvm_trainer
dlib/svm.h
dlib/svm/rvm_abstract.h

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.

rvm_ex.cpp.html
krr_trainer
dlib/svm.h
dlib/svm/krr_trainer_abstract.h

Performs kernel ridge regression and outputs a decision_function that represents the learned function.

The implementation is done using the empirical_kernel_map and linearly_independent_subset_finder to kernelize the rr_trainer object. Thus it allows you to run the algorithm on large datasets and obtain sparse outputs. It is also capable of automatically estimating its regularization parameter using leave-one-out cross-validation.
krr_regression_ex.cpp.html
krr_classification_ex.cpp.html
rr_trainer
dlib/svm.h
dlib/svm/rr_trainer_abstract.h

Performs linear ridge regression and outputs a decision_function that represents the learned function. In particular, this object can only be used with the linear_kernel. It is optimized for the linear case where the number of features in each sample vector is small (i.e. on the order of 1000 or less since the algorithm is cubic in the number of features.). If you want to use a nonlinear kernel then you should use the krr_trainer.

This object is capable of automatically estimating its regularization parameter using leave-one-out cross-validation.
svr_trainer
dlib/svm.h
dlib/svm/svr_trainer_abstract.h

This object implements a trainer for performing epsilon-insensitive support vector regression. It is implemented using the SMO algorithm, allowing the use of non-linear kernels. If you are interested in performing support vector regression with a linear kernel and you have a lot of training data then you should use the svr_linear_trainer which is highly optimized for this case.

The implementation of the eps-SVR training algorithm used by this object is based on the following paper:

- 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

svr_ex.cpp.html
svr_linear_trainer
dlib/svm.h
dlib/svm/svr_linear_trainer_abstract.h
This object implements a trainer for performing epsilon-insensitive support vector regression. It uses the oca optimizer so it is very efficient at solving this problem when linear kernels are used, making it suitable for use with large datasets.
svm_nu_trainer
dlib/svm.h
dlib/svm/svm_nu_trainer_abstract.h

Trains a nu support vector machine for solving binary classification problems and outputs a decision_function. It is implemented using the SMO algorithm.

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

svm_ex.cpp.html
model_selection_ex.cpp.html
svm_one_class_trainer
dlib/svm.h
dlib/svm/svm_one_class_trainer_abstract.h

Trains a one-class support vector classifier and outputs a decision_function. It is implemented using the SMO algorithm.

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

- 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

one_class_classifiers_ex.cpp.html
svm_c_trainer
dlib/svm.h
dlib/svm/svm_c_trainer_abstract.h

Trains a C support vector machine for solving binary classification problems and outputs a decision_function. It is implemented using the SMO algorithm.

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

- 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

svm_c_ex.cpp.html
svm_c_linear_dcd_trainer
dlib/svm.h
dlib/svm/svm_c_linear_dcd_trainer_abstract.h
This object represents a tool for training the C formulation of a support vector machine to solve binary classification problems. It is optimized for the case where linear kernels are used and is implemented using the method described in the following paper:

> A Dual Coordinate Descent Method for Large-scale Linear SVM by Cho-Jui Hsieh, Kai-Wei Chang, and Chih-Jen Lin

This trainer has the ability to disable the bias term and also to force the last element of the learned weight vector to be 1. Additionally, it can be warm-started from the solution to a previous training run.
one_class_classifiers_ex.cpp.html
svm_c_linear_trainer
dlib/svm.h
dlib/svm/svm_c_linear_trainer_abstract.h
This object represents a tool for training the C formulation of a support vector machine to solve binary classification problems. It is optimized for the case where linear kernels are used and 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.

This trainer has the ability to restrict the learned weights to non-negative values.
svm_sparse_ex.cpp.html
svm_rank_trainer
dlib/svm.h
dlib/svm/svm_rank_trainer_abstract.h
This object represents a tool for training a ranking support vector machine using linear kernels. In particular, this object is a tool for training the Ranking SVM described in the paper:

> Optimizing Search Engines using Clickthrough Data by Thorsten Joachims

Finally, note that the implementation of this object is done using the oca optimizer and count_ranking_inversions method. This means that it runs in O(n*log(n)) time, making it suitable for use with large datasets.
svm_rank_ex.cpp.html
svm_rank.py.html
shape_predictor_trainer
dlib/image_processing.h
dlib/image_processing/shape_predictor_abstract.h
This object is a tool for training shape_predictors based on annotated training images. Its implementation uses the algorithm described in:

> One Millisecond Face Alignment with an Ensemble of Regression Trees by Vahid Kazemi and Josephine Sullivan, CVPR 2014

It is capable of learning high quality shape models. For example, this is an example output for one of the faces in the HELEN face dataset:
train_shape_predictor_ex.cpp.html
train_shape_predictor.py.html
svm_c_ekm_trainer
dlib/svm.h
dlib/svm/svm_c_ekm_trainer_abstract.h
This object represents a tool for training the C formulation of a support vector machine for solving binary classification problems. It is implemented using the empirical_kernel_map to kernelize the svm_c_linear_trainer. This makes it a very fast algorithm capable of learning from very large datasets.

normalized_function
dlib/svm.h
dlib/svm/function_abstract.h
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.
svm_ex.cpp.html
probabilistic_decision_function
dlib/svm.h
dlib/svm/function_abstract.h
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.
svm_ex.cpp.html
probabilistic_function
dlib/svm.h
dlib/svm/function_abstract.h
This object represents a binary decision function for use with any kind of binary classifier. It returns an estimate of the probability that a given sample is in the +1 class.
distance_function
dlib/svm.h
dlib/svm/function_abstract.h
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.
decision_function
dlib/svm.h
dlib/svm/function_abstract.h
This object represents a classification or regression function that was learned by a kernel based learning algorithm. Therefore, it is a function object that takes a sample object and returns a scalar value.
svm_ex.cpp.html
one_vs_one_decision_function
dlib/svm.h
dlib/svm/one_vs_one_decision_function_abstract.h
This object represents a multiclass classifier built out of a set of binary classifiers. Each binary classifier is used to vote for the correct multiclass label using a one vs. one strategy. Therefore, if you have N classes then there will be N*(N-1)/2 binary classifiers inside this object.
multiclass_classification_ex.cpp.html
custom_trainer_ex.cpp.html
one_vs_one_trainer
dlib/svm_threaded.h
dlib/svm/one_vs_one_trainer_abstract.h
This object is a tool for turning a bunch of binary classifiers into a multiclass classifier. It does this by training the binary classifiers in a one vs. one fashion. That is, if you have N possible classes then it trains N*(N-1)/2 binary classifiers which are then used to vote on the identity of a test sample.
multiclass_classification_ex.cpp.html
custom_trainer_ex.cpp.html
one_vs_all_decision_function
dlib/svm.h
dlib/svm/one_vs_all_decision_function_abstract.h
This object represents a multiclass classifier built out of a set of binary classifiers. Each binary classifier is used to vote for the correct multiclass label using a one vs. all strategy. Therefore, if you have N classes then there will be N binary classifiers inside this object.
sequence_labeler
dlib/svm.h
dlib/svm/sequence_labeler_abstract.h
This object is a tool for doing sequence labeling. In particular, it is capable of representing sequence labeling models such as those produced by Hidden Markov SVMs or Conditional Random fields. See the following papers for an introduction to these techniques:

> Hidden Markov Support Vector Machines by Y. Altun, I. Tsochantaridis, T. Hofmann
> Shallow Parsing with Conditional Random Fields by Fei Sha and Fernando Pereira

sequence_labeler_ex.cpp.html
sequence_segmenter
dlib/svm.h
dlib/svm/sequence_segmenter_abstract.h
This object is a tool for segmenting a sequence of objects into a set of non-overlapping chunks. An example sequence segmentation task is to take English sentences and identify all the named entities. In this example, you would be using a sequence_segmenter to find all the chunks of contiguous words which refer to proper names.

Internally, the sequence_segmenter uses the BIO (Begin, Inside, Outside) or BILOU (Begin, Inside, Last, Outside, Unit) sequence tagging model. Moreover, it is implemented using a sequence_labeler object and therefore sequence_segmenter objects are examples of chain structured conditional random field style sequence taggers.

sequence_segmenter.py.html
sequence_segmenter_ex.cpp.html
assignment_function
dlib/svm.h
dlib/svm/assignment_function_abstract.h
This object is a tool for solving the optimal assignment problem given a user defined method for computing the quality of any particular assignment.
assignment_learning_ex.cpp.html
track_association_function
dlib/svm.h
dlib/svm/track_association_function_abstract.h
This object is a tool that helps you implement an object tracker. So for example, if you wanted to track people moving around in a video then this object can help. In particular, imagine you have a tool for detecting the positions of each person in an image. Then you can run this person detector on the video and at each time step, i.e. at each frame, you get a set of person detections. However, that by itself doesn't tell you how many people there are in the video and where they are moving to and from. To get that information you need to figure out which detections match each other from frame to frame. This is where the track_association_function comes in. It performs the detection to track association. It will also do some of the track management tasks like creating a new track when a detection doesn't match any of the existing tracks.

Internally, this object is implemented using the assignment_function object. In fact, it's really just a thin wrapper around assignment_function and exists just to provide a more convenient interface to users doing detection to track association.

learning_to_track_ex.cpp.html
lspi
dlib/control.h
dlib/control/lspi_abstract.h
This object is an implementation of the reinforcement learning algorithm described in the following paper:

> Lagoudakis, Michail G., and Ronald Parr. "Least-squares policy iteration." The Journal of Machine Learning Research 4 (2003): 1107-1149.

policy
dlib/control.h
dlib/control/approximate_linear_models_abstract.h
This is a policy (i.e. a control law) based on a linear function approximator. You can use a tool like lspi to learn the parameters of a policy.
process_sample
dlib/control.h
dlib/control/approximate_linear_models_abstract.h
This object holds a training sample for a reinforcement learning algorithm (e.g. lspi). In particular, it contains a state, action, reward, next state sample from some process.
graph_labeler
dlib/graph_cuts.h
dlib/graph_cuts/graph_labeler_abstract.h
This object is a tool for labeling each node in a graph with a value of true or false, subject to a labeling consistency constraint between nodes that share an edge. In particular, this object is useful for representing a graph labeling model learned via some machine learning method, such as the structural_graph_labeling_trainer.
graph_labeling_ex.cpp.html
multiclass_linear_decision_function
dlib/svm.h
dlib/svm/function_abstract.h
This object represents a multiclass classifier built out of a set of binary classifiers. Each binary classifier is used to vote for the correct multiclass label using a one vs. all strategy. Therefore, if you have N classes then there will be N binary classifiers inside this object. Additionally, this object is linear in the sense that each of these binary classifiers is a simple linear plane.
one_vs_all_trainer
dlib/svm_threaded.h
dlib/svm/one_vs_all_trainer_abstract.h
This object is a tool for turning a bunch of binary classifiers into a multiclass classifier. It does this by training the binary classifiers in a one vs. all fashion. That is, if you have N possible classes then it trains N binary classifiers which are then used to vote on the identity of a test sample.
svm_multiclass_linear_trainer
dlib/svm_threaded.h
dlib/svm/svm_multiclass_linear_trainer_abstract.h
This object represents a tool for training a multiclass support vector machine. It is optimized for the case where linear kernels are used and implemented using the structural_svm_problem object.
projection_function
dlib/svm.h
dlib/svm/function_abstract.h
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.
linear_manifold_regularizer_ex.cpp.html
offset_kernel
dlib/svm.h
dlib/svm/kernel_abstract.h
This object represents a kernel with a fixed value offset added to it.
linear_kernel
dlib/svm.h
dlib/svm/kernel_abstract.h
This object represents a linear function kernel for use with kernel learning machines.
histogram_intersection_kernel
dlib/svm.h
dlib/svm/kernel_abstract.h
This object represents a histogram intersection kernel for use with kernel learning machines.
sigmoid_kernel
dlib/svm.h
dlib/svm/kernel_abstract.h
This object represents a sigmoid kernel for use with kernel learning machines.
polynomial_kernel
dlib/svm.h
dlib/svm/kernel_abstract.h
This object represents a polynomial kernel for use with kernel learning machines.
radial_basis_kernel
dlib/svm.h
dlib/svm/kernel_abstract.h
This object represents a radial basis function kernel for use with kernel learning machines.
svm_ex.cpp.html
sparse_histogram_intersection_kernel
dlib/svm.h
dlib/svm/sparse_kernel_abstract.h
This object represents a histogram intersection kernel kernel for use with kernel learning machines that operate on sparse vectors.
sparse_sigmoid_kernel
dlib/svm.h
dlib/svm/sparse_kernel_abstract.h
This object represents a sigmoid kernel for use with kernel learning machines that operate on sparse vectors.
sparse_linear_kernel
dlib/svm.h
dlib/svm/sparse_kernel_abstract.h
This object represents a linear kernel for use with kernel learning machines that operate on sparse vectors.
sparse_polynomial_kernel
dlib/svm.h
dlib/svm/sparse_kernel_abstract.h
This object represents a polynomial kernel for use with kernel learning machines that operate on sparse vectors.
sparse_radial_basis_kernel
dlib/svm.h
dlib/svm/sparse_kernel_abstract.h
This object represents a radial basis function kernel for use with kernel learning machines that operate on sparse vectors.
is_binary_classification_problem
dlib/svm.h
dlib/svm/svm_abstract.h
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.
is_sequence_labeling_problem
dlib/svm.h
dlib/svm/svm_abstract.h
This function takes a set of training data for a sequence labeling problem and reports back if it could possibly be a well formed sequence labeling problem.
is_sequence_segmentation_problem
dlib/svm.h
dlib/svm/svm_abstract.h
This function takes a set of training data for a sequence segmentation problem and reports back if it could possibly be a well formed sequence segmentation problem.
is_assignment_problem
dlib/svm.h
dlib/svm/svm_abstract.h
This function takes a set of training data for an assignment problem and reports back if it could possibly be a well formed assignment problem.
is_track_association_problem
dlib/svm.h
dlib/svm/svm_abstract.h
This function takes a set of training data for a track association learning problem and reports back if it could possibly be a well formed track association problem.
is_graph_labeling_problem
dlib/svm_threaded.h
dlib/svm/structural_svm_graph_labeling_problem_abstract.h
This function takes a set of training data for a graph labeling problem and reports back if it could possibly be a well formed problem.
is_forced_assignment_problem
dlib/svm.h
dlib/svm/svm_abstract.h
This function takes a set of training data for a forced assignment problem and reports back if it could possibly be a well formed forced assignment problem.
is_learning_problem
dlib/svm.h
dlib/svm/svm_abstract.h
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 learning problem. In this case it just means that the two vectors have the same length and aren't empty.
select_all_distinct_labels
dlib/svm.h
dlib/svm/multiclass_tools_abstract.h
This is a function which determines all distinct values present in a std::vector and returns the result.
simplify_linear_decision_function
dlib/svm.h
dlib/svm/simplify_linear_decision_function_abstract.h
This is a set of functions that takes various forms of linear decision functions and collapses them down so that they only compute a single dot product when invoked.
randomize_samples
dlib/svm.h
dlib/svm/svm_abstract.h
Randomizes the order of samples in a column vector containing sample data.
svm_ex.cpp.html
rank_features
dlib/svm.h
dlib/svm/feature_ranking_abstract.h
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.
rank_features_ex.cpp.html
load_mnist_dataset
dlib/data_io.h
dlib/data_io/mnist_abstract.h
Loads the MNIST dataset from disk.
load_image_dataset
dlib/data_io.h
dlib/data_io/load_image_dataset_abstract.h
This is a function which loads the list of images indicated by an image dataset metadata file as well as the box locations for each image. It makes loading the data necessary to train an object_detector a little more convenient.
fhog_object_detector_ex.cpp.html
train_object_detector.cpp.html
load_image_dataset_metadata
dlib/data_io.h
dlib/data_io/image_dataset_metadata.h
dlib comes with a graphical tool for annotating images with labeled rectangles. The tool produces an XML file containing these annotations. Therefore, load_image_dataset_metadata() is a routine for parsing these XML files. Note also that this is the metadata format used by the image labeling tool included with dlib in the tools/imglab folder.
save_image_dataset_metadata
dlib/data_io.h
dlib/data_io/image_dataset_metadata.h
This routine is a tool for saving labeled image metadata to an XML file. In particular, this routine saves the metadata into a form which can be read by the load_image_dataset_metadata routine. Note also that this is the metadata format used by the image labeling tool included with dlib in the tools/imglab folder.
load_libsvm_formatted_data
dlib/data_io.h
dlib/data_io/libsvm_io_abstract.h
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. Also, some LIBSVM formatted files number their features beginning with 1 rather than 0. If this bothers you, then you can fix it by using the fix_nonzero_indexing function on the data after it is loaded.
save_libsvm_formatted_data
dlib/data_io.h
dlib/data_io/libsvm_io_abstract.h
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.
fix_nonzero_indexing
dlib/data_io.h
dlib/data_io/libsvm_io_abstract.h
This is a simple function that takes a std::vector of sparse vectors and makes sure they are zero-indexed (e.g. makes sure the first index value is zero).
find_gamma_with_big_centroid_gap
dlib/svm.h
dlib/svm/feature_ranking_abstract.h
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.
rank_features_ex.cpp.html
compute_mean_squared_distance
dlib/svm.h
dlib/svm/feature_ranking_abstract.h
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.
batch
dlib/svm.h
dlib/svm/pegasos_abstract.h
This is a convenience function for creating batch_trainer objects.
svm_pegasos_ex.cpp.html
verbose_batch
dlib/svm.h
dlib/svm/pegasos_abstract.h
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.
svm_pegasos_ex.cpp.html
batch_cached
dlib/svm.h
dlib/svm/pegasos_abstract.h
This is a convenience function for creating batch_trainer objects that are setup to use a kernel matrix cache.
verbose_batch_cached
dlib/svm.h
dlib/svm/pegasos_abstract.h
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.
batch_trainer
dlib/svm.h
dlib/svm/pegasos_abstract.h
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.
null_trainer_type
dlib/svm.h
dlib/svm/null_trainer_abstract.h
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.

null_trainer
dlib/svm.h
dlib/svm/null_trainer_abstract.h
This is a convenience function for creating null_trainer_type objects.
roc_c1_trainer
dlib/svm.h
dlib/svm/roc_trainer_abstract.h
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.
roc_c2_trainer
dlib/svm.h
dlib/svm/roc_trainer_abstract.h
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.
roc_trainer_type
dlib/svm.h
dlib/svm/roc_trainer_abstract.h
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);

reduced_decision_function_trainer
dlib/svm.h
dlib/svm/reduced_abstract.h
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.
reduced
dlib/svm.h
dlib/svm/reduced_abstract.h
This is a convenience function for creating reduced_decision_function_trainer objects.
reduced2
dlib/svm.h
dlib/svm/reduced_abstract.h
This is a convenience function for creating reduced_decision_function_trainer2 objects.
svm_ex.cpp.html
reduced_decision_function_trainer2
dlib/svm.h
dlib/svm/reduced_abstract.h

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. The gradient based optimization is implemented using the approximate_distance_function routine.

svm_ex.cpp.html
approximate_distance_function
dlib/svm.h
dlib/svm/reduced_abstract.h
This function attempts to find a distance_function object which is close to a target distance_function. That is, it searches for an X such that target(X) is minimized. Critically, X may be set to use fewer basis vectors than the target.

The optimization begins with an initial guess supplied by the user and searches for an X which locally minimizes target(X). Since this problem can have many local minima the quality of the starting point can significantly influence the results.

test_binary_decision_function
dlib/svm.h
dlib/svm/svm_abstract.h
Tests a decision_function that represents a binary decision function and returns the test accuracy.

test_multiclass_decision_function
dlib/svm.h
dlib/svm/cross_validate_multiclass_trainer_abstract.h
Tests a multiclass decision function (e.g. one_vs_one_decision_function) and returns a confusion matrix describing the results.
multiclass_classification_ex.cpp.html
custom_trainer_ex.cpp.html
cross_validate_trainer_threaded
dlib/svm_threaded.h
dlib/svm/svm_threaded_abstract.h
Performs k-fold cross validation on a user supplied binary classification 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.
cross_validate_trainer
dlib/svm.h
dlib/svm/svm_abstract.h
Performs k-fold cross validation on a user supplied binary classification trainer object such as the svm_nu_trainer or rbf_network_trainer.
svm_ex.cpp.html
model_selection_ex.cpp.html
cross_validate_multiclass_trainer
dlib/svm.h
dlib/svm/cross_validate_multiclass_trainer_abstract.h
Performs k-fold cross validation on a user supplied multiclass classification trainer object such as the one_vs_one_trainer. The result is described by a confusion matrix.
multiclass_classification_ex.cpp.html
custom_trainer_ex.cpp.html
cross_validate_regression_trainer
dlib/svm.h
dlib/svm/cross_validate_regression_trainer_abstract.h
Performs k-fold cross validation on a user supplied regression trainer object such as the svr_trainer and returns the mean squared error and R-squared value.
svr_ex.cpp.html
cross_validate_sequence_labeler
dlib/svm.h
dlib/svm/cross_validate_sequence_labeler_abstract.h
Performs k-fold cross validation on a user supplied sequence labeling trainer object such as the structural_sequence_labeling_trainer and returns a confusion matrix describing the results.
sequence_labeler_ex.cpp.html
cross_validate_sequence_segmenter
dlib/svm.h
dlib/svm/cross_validate_sequence_segmenter_abstract.h
Performs k-fold cross validation on a user supplied sequence segmentation trainer object such as the structural_sequence_segmentation_trainer and returns the resulting precision, recall, and F1-score.
sequence_segmenter.py.html
sequence_segmenter_ex.cpp.html
cross_validate_assignment_trainer
dlib/svm.h
dlib/svm/cross_validate_assignment_trainer_abstract.h
Performs k-fold cross validation on a user supplied assignment trainer object such as the structural_assignment_trainer and returns the fraction of assignments predicted correctly.
assignment_learning_ex.cpp.html
cross_validate_track_association_trainer
dlib/svm_threaded.h
dlib/svm/cross_validate_track_association_trainer_abstract.h
Performs k-fold cross validation on a user supplied track association trainer object such as the structural_track_association_trainer and returns the fraction of detections which were correctly associated to their tracks.
learning_to_track_ex.cpp.html
cross_validate_graph_labeling_trainer
dlib/svm_threaded.h
dlib/svm/cross_validate_graph_labeling_trainer_abstract.h
Performs k-fold cross validation on a user supplied graph labeling trainer object such as the structural_graph_labeling_trainer and returns the fraction of assignments predicted correctly.
graph_labeling_ex.cpp.html
cross_validate_ranking_trainer
dlib/svm.h
dlib/svm/ranking_tools_abstract.h
Performs k-fold cross validation on a user supplied ranking trainer object such as the svm_rank_trainer and returns the fraction of ranking pairs ordered correctly as well as the mean average precision.
svm_rank_ex.cpp.html
svm_rank.py.html
test_sequence_labeler
dlib/svm.h
dlib/svm/cross_validate_sequence_labeler_abstract.h
Tests a sequence_labeler on a set of data and returns a confusion matrix describing the results.
sequence_labeler_ex.cpp.html
test_sequence_segmenter
dlib/svm.h
dlib/svm/cross_validate_sequence_segmenter_abstract.h
Tests a sequence_segmenter on a set of data and returns the resulting precision, recall, and F1-score.
sequence_segmenter.py.html
sequence_segmenter_ex.cpp.html
test_assignment_function
dlib/svm.h
dlib/svm/cross_validate_assignment_trainer_abstract.h
Tests an assignment_function on a set of data and returns the fraction of assignments predicted correctly.
assignment_learning_ex.cpp.html
test_track_association_function
dlib/svm_threaded.h
dlib/svm/cross_validate_track_association_trainer_abstract.h
Tests a track_association_function on a set of data and returns the fraction of detections which were correctly associated to their tracks.
learning_to_track_ex.cpp.html
test_graph_labeling_function
dlib/svm_threaded.h
dlib/svm/cross_validate_graph_labeling_trainer_abstract.h
Tests a graph_labeler on a set of data and returns the fraction of labels predicted correctly.
average_precision
dlib/statistics.h
dlib/statistics/average_precision_abstract.h
This function computes the average precision of a ranking.
equal_error_rate
dlib/statistics.h
dlib/statistics/lda_abstract.h
This function finds a threshold that best separates the elements of two vectors by selecting the threshold with equal error rate. It also reports the value of the equal error rate.
test_ranking_function
dlib/svm.h
dlib/svm/ranking_tools_abstract.h
Tests a decision_function's ability to correctly rank a dataset and returns the resulting ranking accuracy and mean average precision metrics.
svm_rank_ex.cpp.html
svm_rank.py.html
test_shape_predictor
dlib/image_processing.h
dlib/image_processing/shape_predictor_abstract.h
Tests a shape_predictor's ability to correctly predict the part locations of objects. The output is the average distance (measured in pixels) between each part and its true location. You can optionally normalize each distance using a user supplied scale. For example, when performing face landmarking, you might want to normalize the distances by the interocular distance.
train_shape_predictor_ex.cpp.html
train_shape_predictor.py.html
cross_validate_object_detection_trainer
dlib/svm.h
dlib/svm/cross_validate_object_detection_trainer_abstract.h
Performs k-fold cross validation on a user supplied object detection trainer such as the structural_object_detection_trainer and returns the precision and recall.
object_detector_ex.cpp.html
object_detector_advanced_ex.cpp.html
train_object_detector.cpp.html
test_object_detection_function
dlib/svm.h
dlib/svm/cross_validate_object_detection_trainer_abstract.h
Tests an object detector such as the object_detector and returns the precision and recall.
fhog_object_detector_ex.cpp.html
object_detector_ex.cpp.html
object_detector_advanced_ex.cpp.html
train_object_detector.cpp.html
test_regression_function
dlib/svm.h
dlib/svm/cross_validate_regression_trainer_abstract.h
Tests a regression function (e.g. decision_function) and returns the mean squared error and R-squared value.
structural_svm_problem
dlib/svm.h
dlib/svm/structural_svm_problem_abstract.h
This object, when used with the oca optimizer, is a tool for solving the optimization problem associated with a structural support vector machine. A structural SVM is a supervised machine learning method for learning to predict complex outputs. This is contrasted with a binary classifier which makes only simple yes/no predictions. A structural SVM, on the other hand, can learn to predict complex outputs such as entire parse trees or DNA sequence alignments. To do this, it learns a function F(x,y) which measures how well a particular data sample x matches a label y. When used for prediction, the best label for a new x is given by the y which maximizes F(x,y).

For an introduction to structured support vector machines you should consult the following paper:

> Predicting Structured Objects with Support Vector Machines by Thorsten Joachims, Thomas Hofmann, Yisong Yue, and Chun-nam Yu

For a more detailed discussion of the particular algorithm implemented by this object see the following paper:

> T. Joachims, T. Finley, Chun-Nam Yu, Cutting-Plane Training of Structural SVMs, Machine Learning, 77(1):27-59, 2009.

Note that this object is essentially a tool for solving the 1-Slack structural SVM with margin-rescaling. Specifically, see Algorithm 3 in the above referenced paper.

Finally, for a very detailed introduction to this subject, you should consider the book:

> Structured Prediction and Learning in Computer Vision by Sebastian Nowozin and Christoph H. Lampert

svm_struct.py.html
svm_struct_ex.cpp.html
structural_svm_problem_threaded
dlib/svm_threaded.h
dlib/svm/structural_svm_problem_threaded_abstract.h
This is just a version of the structural_svm_problem which is capable of using multiple cores/threads at a time. You should use it if you have a multi-core CPU and the separation oracle takes a long time to compute. Or even better, if you have multiple computers then you can use the svm_struct_controller_node to distribute the work across many computers.
svm_struct_ex.cpp.html
structural_svm_object_detection_problem
dlib/svm_threaded.h
dlib/svm/structural_svm_object_detection_problem_abstract.h
This object is a tool for learning the parameter vector needed to use a scan_fhog_pyramid, scan_image_pyramid, scan_image_boxes, or scan_image_custom object.

It learns the parameter vector by formulating the problem as a structural SVM problem. The exact details of the method are described in the paper Max-Margin Object Detection by Davis E. King.

structural_svm_sequence_labeling_problem
dlib/svm_threaded.h
dlib/svm/structural_svm_sequence_labeling_problem_abstract.h
This object is a tool for learning the weight vector needed to use a sequence_labeler object.

It learns the parameter vector by formulating the problem as a structural SVM problem. The general approach is discussed in the paper:

> Hidden Markov Support Vector Machines by Y. Altun, I. Tsochantaridis, T. Hofmann

While the particular optimization strategy used is the method from:

> T. Joachims, T. Finley, Chun-Nam Yu, Cutting-Plane Training of Structural SVMs, Machine Learning, 77(1):27-59, 2009.

structural_svm_assignment_problem
dlib/svm_threaded.h
dlib/svm/structural_svm_assignment_problem_abstract.h
This object is a tool for learning the parameters needed to use an assignment_function object. It learns the parameters by formulating the problem as a structural SVM problem.
structural_svm_graph_labeling_problem
dlib/svm_threaded.h
dlib/svm/structural_svm_graph_labeling_problem_abstract.h
This object is a tool for learning the weight vectors needed to use a graph_labeler object. It learns the parameter vectors by formulating the problem as a structural SVM problem.
structural_object_detection_trainer
dlib/svm_threaded.h
dlib/svm/structural_object_detection_trainer_abstract.h
This object is a tool for learning to detect objects in images based on a set of labeled images. The training procedure produces an object_detector which can be used to predict the locations of objects in new images. It learns the parameter vector by formulating the problem as a structural SVM problem. The exact details of the method are described in the paper Max-Margin Object Detection by Davis E. King.

Note that this is just a convenience wrapper around the structural_svm_object_detection_problem to make it look similar to all the other trainers in dlib.

fhog_object_detector_ex.cpp.html
object_detector_ex.cpp.html
object_detector_advanced_ex.cpp.html
train_object_detector.cpp.html
train_object_detector.py.html
structural_sequence_labeling_trainer
dlib/svm_threaded.h
dlib/svm/structural_sequence_labeling_trainer_abstract.h
This object is a tool for learning to do sequence labeling based on a set of training data. The training procedure produces a sequence_labeler object which can be use to predict the labels of new data sequences.

Note that this is just a convenience wrapper around the structural_svm_sequence_labeling_problem to make it look similar to all the other trainers in dlib.

sequence_labeler_ex.cpp.html
structural_sequence_segmentation_trainer
dlib/svm_threaded.h
dlib/svm/structural_sequence_segmentation_trainer_abstract.h
This object is a tool for learning to do sequence segmentation based on a set of training data. The training procedure produces a sequence_segmenter object which can be used to identify the sub-segments of new data sequences.

This object internally uses the structural_sequence_labeling_trainer to solve the learning problem.

sequence_segmenter.py.html
sequence_segmenter_ex.cpp.html
structural_graph_labeling_trainer
dlib/svm_threaded.h
dlib/svm/structural_graph_labeling_trainer_abstract.h
This object is a tool for learning to solve a graph labeling problem based on a training dataset of example labeled graphs. The training procedure produces a graph_labeler object which can be used to predict the labelings of new graphs.

To elaborate, a graph labeling problem is a task to learn a binary classifier which predicts the label of each node in a graph. Additionally, we have information in the form of edges between nodes where edges are present when we believe the linked nodes are likely to have the same label. Therefore, part of a graph labeling problem is to learn to score each edge in terms of how strongly the edge should enforce labeling consistency between its two nodes.

Note that this is just a convenience wrapper around the structural_svm_graph_labeling_problem to make it look similar to all the other trainers in dlib. You might also consider reading the book Structured Prediction and Learning in Computer Vision by Sebastian Nowozin and Christoph H. Lampert since it contains a good introduction to machine learning methods such as the algorithm implemented by the structural_graph_labeling_trainer.

graph_labeling_ex.cpp.html
structural_assignment_trainer
dlib/svm_threaded.h
dlib/svm/structural_assignment_trainer_abstract.h
This object is a tool for learning to solve an assignment problem based on a training dataset of example assignments. The training procedure produces an assignment_function object which can be used to predict the assignments of new data.

Note that this is just a convenience wrapper around the structural_svm_assignment_problem to make it look similar to all the other trainers in dlib.
assignment_learning_ex.cpp.html
structural_track_association_trainer
dlib/svm_threaded.h
dlib/svm/structural_track_association_trainer_abstract.h
This object is a tool for learning to solve a track association problem. That is, it takes in a set of training data and outputs a track_association_function you can use to do detection to track association.
learning_to_track_ex.cpp.html
svm_struct_controller_node
dlib/svm_threaded.h
dlib/svm/structural_svm_distributed_abstract.h
This object is a tool for distributing the work involved in solving a structural_svm_problem across many computers.
svm_struct_processing_node
dlib/svm_threaded.h
dlib/svm/structural_svm_distributed_abstract.h
This object is a tool for distributing the work involved in solving a structural_svm_problem across many computers.