.. _package-rst-classification:
============================
Package rst.classification
============================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"1" [label=< | ClassificationResult |
|
| OCTET-VECTOR | decided_class |
| ClassWithProbability | classes |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | ClassWithProbability |
|
| OCTET-VECTOR | name |
| FLOAT32 | confidence |
>,shape=box,style=filled,fillcolor="white"];
"1" -> "2" [];
"1":classes -> "2" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`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
.. 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 `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/classification/ClassificationResult.proto
:lines: 19-58
:language: protobuf
:emphasize-lines: 8-8,38-38
.. _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
Represents a single class a classification process can return
with the probability that this class applies to the classified
aspect.
.. py:attribute:: name
:type: :py:class:`OCTET-VECTOR`
Name of the class (ASCII string).
.. py:attribute:: confidence
:type: :py:class:`FLOAT32`
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 `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/classification/ClassificationResult.proto
:lines: 33-47
:language: protobuf
:emphasize-lines: 6-6,13-13