.. _package-rst-classification:

============================
 Package rst.classification
============================



In machine learning and statistics, classification is the problem
of identifying to which of a set of categories (sub-populations) a
new observation belongs.

This package contains data types representing classification
problems and classification results (e.g. :py:class:`ClassificationResult <rst.classification.ClassificationResult>`).


.. seealso::

   Wikipedia article containing the definition above
     http://en.wikipedia.org/wiki/Statistical_classification



Messages
========

.. container:: mess4ge-multi

   .. container:: mess4ge-graph

      .. digraph:: message_graph

         
         fontname="Arial";
         fontsize=11;
         stylesheet="../_static/corlab.css";
           node [fontsize=11]
           node [fontname="Arial"]
           edge [fontsize=11]
           edge [fontname="Arial"]
           "1" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult" TITLE="Structure rst.classification.ClassificationResult" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">ClassificationResult</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.decided_class" TITLE="Field rst.classification.ClassificationResult.decided_class" TARGET="_parent" PORT="decided_class">decided_class</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability" TITLE="Structure rst.classification.ClassificationResult.ClassWithProbability" TARGET="_parent">ClassWithProbability</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.classes" TITLE="Field rst.classification.ClassificationResult.classes" TARGET="_parent" PORT="classes">classes</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability" TITLE="Structure rst.classification.ClassificationResult.ClassWithProbability" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">ClassWithProbability</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability.name" TITLE="Field rst.classification.ClassificationResult.ClassWithProbability.name" TARGET="_parent" PORT="name">name</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-classification.html#rst.classification.ClassificationResult.ClassWithProbability.confidence" TITLE="Field rst.classification.ClassificationResult.ClassWithProbability.confidence" TARGET="_parent" PORT="confidence">confidence</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "1" -> "2" [dir=both,arrowtail=odiamond];
           "1":classes -> "2" [];
         

   .. container:: mess4ge-list

      .. container:: messages

         * :ref:`ClassificationResult <message-rst-classification-classificationresult>`

      .. container:: clearer

         clearer: should be made invisible via css

.. _message-rst-classification-classificationresult:

Message ClassificationResult
----------------------------

.. container:: message-rst-classification-classificationresult-multi

   .. container:: message-rst-classification-classificationresult-documentation

      .. py:class:: rst.classification.ClassificationResult

         
         
         A class representing the result of a classification process.
         
         An example of such a result could be the output of an SVM-based
         classifier.
         
         In the simplest form, only the name of a decided class is
         given. However, it is also possible to give the whole vector of
         possible classes with their probabilities.
         
         
         .. codeauthor:: Johannes Wienke <jwienke@techfak.uni-bielefeld.de>
         

         .. py:attribute:: decided_class

            :type: :py:class:`OCTET-VECTOR`

            
            
            A shortcut to get the most likely class easily.
            
            This needs to be an ASCII string.

         .. py:attribute:: classes

            :type: array of  :py:class:`rst.classification.ClassificationResult.ClassWithProbability`

            
            
            The complete vector of classes with their probabilities if
            suitable.
            
            The results in this vector should of cause not contradict
            decided_class.

   .. container:: message-rst-classification-classificationresult-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/classification/ClassificationResult.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/classification/ClassificationResult.proto
         :lines: 17-54
         :language: protobuf
         :emphasize-lines: 8-8,36-36



.. _message-rst-classification-classificationresult-classwithprobability:

Message ClassWithProbability
----------------------------

.. container:: message-rst-classification-classificationresult-classwithprobability-multi

   .. container:: message-rst-classification-classificationresult-classwithprobability-documentation

      .. py:class:: rst.classification.ClassificationResult.ClassWithProbability

         
         
         TODO

         .. py:attribute:: name

            :type: :py:class:`OCTET-VECTOR`

            
            
            Name of the class (ASCII string).

         .. py:attribute:: confidence

            :type: :py:class:`FLOAT32`

            **Unit**: TODO
            
            
            
            Some kind of confidence, values are application dependent.
            
            However, values summing up to 1 are preferred.
            

   .. container:: message-rst-classification-classificationresult-classwithprobability-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/classification/ClassificationResult.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/classification/ClassificationResult.proto
         :lines: 29-43
         :language: protobuf
         :emphasize-lines: 6-6,14-14