Commit 67c6bdd2 authored by Davis King's avatar Davis King

Made the specs more clear.

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402915
parent f197611d
...@@ -23,7 +23,7 @@ namespace dlib ...@@ -23,7 +23,7 @@ namespace dlib
{ {
/*! /*!
REQUIREMENTS ON trainer_type REQUIREMENTS ON trainer_type
- trainer_type == some kind of trainer object (e.g. svm_nu_trainer) - trainer_type == some kind of batch trainer object (e.g. svm_nu_trainer)
WHAT THIS OBJECT REPRESENTS WHAT THIS OBJECT REPRESENTS
This object represents an implementation of a reduced set algorithm This object represents an implementation of a reduced set algorithm
...@@ -105,7 +105,7 @@ namespace dlib ...@@ -105,7 +105,7 @@ namespace dlib
/*! /*!
requires requires
- num_sv > 0 - num_sv > 0
- trainer_type == some kind of trainer object that creates decision_function - trainer_type == some kind of batch trainer object that creates decision_function
objects (e.g. svm_nu_trainer) objects (e.g. svm_nu_trainer)
ensures ensures
- returns a reduced_decision_function_trainer object that has been - returns a reduced_decision_function_trainer object that has been
...@@ -123,7 +123,7 @@ namespace dlib ...@@ -123,7 +123,7 @@ namespace dlib
{ {
/*! /*!
REQUIREMENTS ON trainer_type REQUIREMENTS ON trainer_type
- trainer_type == some kind of trainer object (e.g. svm_nu_trainer) - trainer_type == some kind of batch trainer object (e.g. svm_nu_trainer)
- trainer_type::sample_type must be a dlib::matrix object - trainer_type::sample_type must be a dlib::matrix object
- kernel_derivative<trainer_type::kernel_type> must be defined - kernel_derivative<trainer_type::kernel_type> must be defined
...@@ -219,7 +219,7 @@ namespace dlib ...@@ -219,7 +219,7 @@ namespace dlib
/*! /*!
requires requires
- num_sv > 0 - num_sv > 0
- trainer_type == some kind of trainer object that creates decision_function - trainer_type == some kind of batch trainer object that creates decision_function
objects (e.g. svm_nu_trainer) objects (e.g. svm_nu_trainer)
- kernel_derivative<trainer_type::kernel_type> is defined - kernel_derivative<trainer_type::kernel_type> is defined
- eps > 0 - eps > 0
......
...@@ -284,7 +284,7 @@ namespace dlib ...@@ -284,7 +284,7 @@ namespace dlib
requires requires
- 1 < folds <= x.nr() - 1 < folds <= x.nr()
- is_binary_classification_problem(x,y) == true - is_binary_classification_problem(x,y) == true
- trainer_type == some kind of trainer object (e.g. svm_nu_trainer) - trainer_type == some kind of batch trainer object (e.g. svm_nu_trainer)
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. labels in y.
......
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