Commit 01d6b528 authored by Davis King's avatar Davis King

updated the docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402811
parent b42ae61a
...@@ -116,7 +116,8 @@ ...@@ -116,7 +116,8 @@
This is documented in the list of preconditions as This is documented in the list of preconditions as
"<tt>is_binary_classification_problem(x,y) == true</tt>". This precondition is just saying "<tt>is_binary_classification_problem(x,y) == true</tt>". This precondition is just saying
that when you call that when you call
the <tt>is_binary_classification_problem</tt> function on the x and y inputs it had better return true the <a href="algorithms.html#is_binary_classification_problem">is_binary_classification_problem</a>
function on the x and y inputs it had better return true
if you want to use those inputs with the <tt>cross_validate_trainer</tt> function. if you want to use those inputs with the <tt>cross_validate_trainer</tt> function.
Given this information it is trivial to perform input validation. All you have to do is Given this information it is trivial to perform input validation. All you have to do is
call <tt>is_binary_classification_problem</tt> on your input data and you are done. call <tt>is_binary_classification_problem</tt> on your input data and you are done.
...@@ -165,8 +166,7 @@ ...@@ -165,8 +166,7 @@
the <a href="intro.html#Notation">introduction</a>. All code that goes into dlib the <a href="intro.html#Notation">introduction</a>. All code that goes into dlib
must document itself using this notation. You should also separate the implementation must document itself using this notation. You should also separate the implementation
and specification of a component into two separate files as described in the introduction. This and specification of a component into two separate files as described in the introduction. This
way users don't even see implementation details when they look at the documentation for a way users aren't confused or distracted by implementation details when they look at the documentation.
component.
</p> </p>
</ul> </ul>
</li> </li>
......
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