updated the docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403045

docs/docs/ml.xml

@@ -69,6 +69,9 @@
          <item>batch_trainer</item> 
          <item>null_trainer_type</item> 
          <item>null_trainer</item> 
+         <item>roc_trainer_type</item> 
+         <item>roc_c1_trainer</item> 
+         <item>roc_c2_trainer</item> 
       </section>
 
       <section>
@@ -807,6 +810,56 @@
                                  
       </component>
       
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>roc_c1_trainer</name>
+         <file>dlib/svm.h</file>
+         <spec_file link="true">dlib/svm/roc_trainer_abstract.h</spec_file>
+         <description>
+            This is a convenience function for creating 
+            <a href="#roc_trainer_type">roc_trainer_type</a> objects that are
+            setup to pick a point on the ROC curve with respect to the +1 class.
+         </description>
+                                 
+      </component>
+      
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>roc_c2_trainer</name>
+         <file>dlib/svm.h</file>
+         <spec_file link="true">dlib/svm/roc_trainer_abstract.h</spec_file>
+         <description>
+            This is a convenience function for creating 
+            <a href="#roc_trainer_type">roc_trainer_type</a> objects that are
+            setup to pick a point on the ROC curve with respect to the -1 class.
+         </description>
+                                 
+      </component>
+      
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>roc_trainer_type</name>
+         <file>dlib/svm.h</file>
+         <spec_file link="true">dlib/svm/roc_trainer_abstract.h</spec_file>
+         <description>
+                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.  
+
+               <p>
+                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:
+                <tt>roc_trainer_type&lt;trainer_type&gt;(your_trainer, 0.99, +1);</tt>
+               </p>
+         </description>
+                                 
+      </component>
+      
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/term_index.xml

@@ -457,6 +457,9 @@
 
          <term file="ml.html" name="null_trainer"/>
          <term file="ml.html" name="null_trainer_type"/>
+         <term file="ml.html" name="roc_c1_trainer"/>
+         <term file="ml.html" name="roc_c2_trainer"/>
+         <term file="ml.html" name="roc_trainer_type"/>
 
          <term file="ml.html" name="decision_function"/>
          <term file="ml.html" name="normalized_function"/>