Package rst.classification

Not documented

Messages

• ClassificationResult

clearer: should be made invisible via css

Message ClassificationResult

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.

Code author: Johannes Wienke <jwienke@techfak.uni-bielefeld.de>

decided_class

Type:OCTET-VECTOR

A shortcut to get the most likely class easily.

This needs to be an ASCII string.

classes

Type:array of 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.

Download this file

message ClassificationResult {

    /**
     * A shortcut to get the most likely class easily.
     *
     * This needs to be an ASCII string.
     */
    required bytes decided_class = 1;

    /**
     * Represents a single class a classification process can return
     * with the probability that this class applies to the classified
     * aspect.
     */
    message ClassWithProbability {

        /**
         * Name of the class (ASCII string).
         */
        required bytes name = 1;

        /**
         * Some kind of confidence, values are application dependent.
         *
         * However, values summing up to 1 are preferred.
         */
        required float confidence = 2;

    }

    /**
     * The complete vector of classes with their probabilities if
     * suitable.
     *
     * The results in this vector should of cause not contradict
     * decided_class.
     */
    repeated ClassWithProbability classes = 2;

}

Message ClassWithProbability

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.

name

Type:OCTET-VECTOR

Name of the class (ASCII string).

confidence

Type:FLOAT32

Some kind of confidence, values are application dependent.

However, values summing up to 1 are preferred.

Download this file

    message ClassWithProbability {

        /**
         * Name of the class (ASCII string).
         */
        required bytes name = 1;

        /**
         * Some kind of confidence, values are application dependent.
         *
         * However, values summing up to 1 are preferred.
         */
        required float confidence = 2;

    }