org.jpmml.evaluator

Interface HasProbability

All Superinterfaces:

CategoricalResultFeature<java.lang.Object>, ResultFeature

All Known Implementing Classes:

AggregateProbabilityDistribution, NeuronProbabilityDistribution, NodeScoreDistribution, ProbabilityDistribution, VoteProbabilityDistribution

public interface HasProbability
extends CategoricalResultFeature<java.lang.Object>

A marker interface for classification results that provide a probability distribution.

Probability represents a degree of certainty that the sample belongs to a particular category. Probabilities are required to sum to 1 across all categories. Ideally, the probability of the predicted category should approach 1.0, and the probabilities of all other categories should approach 0.0.

See Also:

ResultFeature.PROBABILITY

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getProbability(java.lang.Object category) Gets the probability of the specified category.
Report	getProbabilityReport(java.lang.Object category)

Methods inherited from interface org.jpmml.evaluator.CategoricalResultFeature

getCategories

Method Detail

getProbability

java.lang.Double getProbability(java.lang.Object category)

Gets the probability of the specified category.

Returns:

A probability in the range from 0.0 to 1.0. The probability of an unknown category is 0.0.

See Also:

CategoricalResultFeature.getCategories()

getProbabilityReport

Report getProbabilityReport(java.lang.Object category)

See Also:

CategoricalResultFeature.getCategories()