NextCloud/dlib
1
0
Fork 0
mirror of https://github.com/davisking/dlib.git synced 2024-11-01 10:14:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated the docs

Browse Source 
--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402811
This commit is contained in:
Davis King 2009-01-16 04:45:09 +00:00
parent b42ae61a28
commit 01d6b52832
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/howto_contribute.xml
View File

@ -116,7 +116,8 @@
This is documented in the list of preconditions as
"<tt>is_binary_classification_problem(x,y) == true</tt>". This precondition is just saying
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.
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.
@ -165,8 +166,7 @@
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
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
component.
way users aren't confused or distracted by implementation details when they look at the documentation.
</p>
</ul>
</li>