Commit 07140ec9 authored by Davis King's avatar Davis King

Added missing comments and fixed some existing ones.

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402230
parent 5874bcd1
...@@ -7,6 +7,7 @@ ...@@ -7,6 +7,7 @@
#include "../matrix/matrix_abstract.h" #include "../matrix/matrix_abstract.h"
#include "../algs.h" #include "../algs.h"
#include "../serialize.h" #include "../serialize.h"
#include "kernel_abstract.h"
namespace dlib namespace dlib
{ {
...@@ -17,6 +18,9 @@ namespace dlib ...@@ -17,6 +18,9 @@ namespace dlib
class krls class krls
{ {
/*! /*!
REQUIREMENTS ON kernel_type
is a kernel function object as defined in dlib/svm/kernel_abstract.h
INITIAL VALUE INITIAL VALUE
- dictionary_size() == 0 - dictionary_size() == 0
......
...@@ -62,8 +62,8 @@ namespace dlib ...@@ -62,8 +62,8 @@ namespace dlib
- y(i) == -1 or +1 - y(i) == -1 or +1
- y(i) is the class that should be assigned to training example x(i) - y(i) is the class that should be assigned to training example x(i)
- 0 < nu < maximum_nu(y) - 0 < nu < maximum_nu(y)
- kernel_function == a kernel function object type as defined at the top - kernel_function == a kernel function object type as defined at the
of this document. top of dlib/svm/kernel_abstract.h
ensures ensures
- trains a nu support vector classifier given the training samples in x and - trains a nu support vector classifier given the training samples in x and
labels in y. Training is done when the error is less than eps. labels in y. Training is done when the error is less than eps.
...@@ -112,8 +112,8 @@ namespace dlib ...@@ -112,8 +112,8 @@ namespace dlib
- y(i) == -1 or +1 - y(i) == -1 or +1
- y(i) is the class that should be assigned to training example x(i) - y(i) is the class that should be assigned to training example x(i)
- 0 < nu < maximum_nu(y) - 0 < nu < maximum_nu(y)
- kernel_function == a kernel function object type as defined at the top - kernel_function == a kernel function object type as defined at the
of this document. top of dlib/svm/kernel_abstract.h
ensures ensures
- trains a nu support vector classifier given the training samples in x and - trains a nu support vector classifier given the training samples in x and
labels in y. Training is done when the error is less than eps. labels in y. Training is done when the error is less than eps.
...@@ -158,8 +158,8 @@ namespace dlib ...@@ -158,8 +158,8 @@ namespace dlib
- y(i) == -1 or +1 - y(i) == -1 or +1
- y(i) is the class that should be assigned to training example x(i) - y(i) is the class that should be assigned to training example x(i)
- 0 < nu < maximum_nu(y) - 0 < nu < maximum_nu(y)
- kernel_function == a kernel function object type as defined at the top - kernel_function == a kernel function object type as defined at the
of this document. top of dlib/svm/kernel_abstract.h
ensures ensures
- performs k-fold cross validation by training a nu-svm using the svm_nu_train() - performs k-fold cross validation by training a nu-svm using the svm_nu_train()
function. Each fold is tested using the learned decision_function and the function. Each fold is tested using the learned decision_function and the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment