All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jpmml.evaluator.HasProbability Maven / Gradle / Ivy

There is a newer version: 1.6.6
Show newest version
/*
 * Copyright (c) 2013 Villu Ruusmann
 *
 * This file is part of JPMML-Evaluator
 *
 * JPMML-Evaluator is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JPMML-Evaluator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with JPMML-Evaluator.  If not, see .
 */
package org.jpmml.evaluator;

/**
 * 

* 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 org.dmg.pmml.ResultFeature#PROBABILITY */ public interface HasProbability extends CategoricalResultFeature { /** *

* Gets the probability of the specified category. *

* * @return A probability in the range from 0.0 to 1.0. * The probability of an unknown category is 0.0. * * @see #getCategories() */ Double getProbability(Object category); /** * @see #getCategories() */ Report getProbabilityReport(Object category); }