weka.etplugin.metrics

Class VariationOfInformation

java.lang.Object

weka.classifiers.evaluation.AbstractEvaluationMetric

weka.etplugin.metrics.VariationOfInformation

All Implemented Interfaces:

Serializable, InformationTheoreticEvaluationMetric, TechnicalInformationHandler

public class VariationOfInformation
extends AbstractEvaluationMetric
implements InformationTheoreticEvaluationMetric, TechnicalInformationHandler

The Variation of Information is the sum the mutually conditioned entropies between the input and the output of the classifier. \[ VI = H_{X|Y} + H_{Y|X} \]
For more information, see

Valverde-Albacete, F. J., & Peláez-Moreno, C. (2010). Two information-theoretic tools to assess the performance of multi-class classifiers. Pattern Recognition Letters, Volume 31, Issue 12, 1 September 2010, Pages 1665-1671.

NOTE: This class needs to have an associated Evaluation object to compute the metric. The Evaluation object can be set via AbstractEvaluationMetric.setBaseEvaluation(Evaluation eval).
If the package is properly installed in Weka, a reference to the object of this class associated with every Evaluation object can be obtained via the method Evaluation.getPluginMetric(String metricName), or the method Evaluation.getPluginMetrics() to get a list of all the plugin metrics associated with that Evaluation object.

Author:

Antonio Pastor

See Also:

Evaluation, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class weka.classifiers.evaluation.AbstractEvaluationMetric

AbstractEvaluationMetric.UnknownStatisticException

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRIC_NAME Constant string with the metric name

Constructor Summary

Constructors

Constructor and Description
VariationOfInformation()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	appliesToNominalClass() Returns true.
boolean	appliesToNumericClass() Returns false.
String	getMetricDescription() Get a short description of this metric.
String	getMetricName() Get the name of this metric.
double	getStatistic(String statName) Get the value of the named statistic, should be "Variation of Information".
List<String>	getStatisticNames() Get a list with the name of the metric.
TechnicalInformation	getTechnicalInformation() Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
boolean	statisticIsMaximisable(String statName) Returns false.
String	toSummaryString() Returns a formatted string (suitable for displaying in console or GUI output) containing this metric.
void	updateStatsForClassifier(double[] predictedDistribution, Instance instance) Not used.
void	updateStatsForConditionalDensityEstimator(ConditionalDensityEstimator classifier, Instance classMissing, double classValue) Not used.
void	updateStatsForPredictor(double predictedValue, Instance instance) Not used.

Methods inherited from class weka.classifiers.evaluation.AbstractEvaluationMetric

getPluginMetrics, setBaseEvaluation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METRIC_NAME

public static String METRIC_NAME

Constant string with the metric name

Constructor Detail

VariationOfInformation

public VariationOfInformation()

Method Detail

toSummaryString

public String toSummaryString()

Returns a formatted string (suitable for displaying in console or GUI output) containing this metric.

Specified by:

toSummaryString in interface InformationTheoreticEvaluationMetric

Returns:

a formatted string containing the metric

appliesToNominalClass

public boolean appliesToNominalClass()

Returns true.

Specified by:

appliesToNominalClass in class AbstractEvaluationMetric

appliesToNumericClass

public boolean appliesToNumericClass()

Returns false.

Specified by:

appliesToNumericClass in class AbstractEvaluationMetric

statisticIsMaximisable

public boolean statisticIsMaximisable(String statName)

Returns false.

Overrides:

statisticIsMaximisable in class AbstractEvaluationMetric

getMetricName

public String getMetricName()

Get the name of this metric.

Specified by:

getMetricName in class AbstractEvaluationMetric

Returns:

the name of this metric

getMetricDescription

public String getMetricDescription()

Get a short description of this metric.

Specified by:

getMetricDescription in class AbstractEvaluationMetric

Returns:

a short description of this metric

getStatisticNames

public List<String> getStatisticNames()

Get a list with the name of the metric.

Specified by:

getStatisticNames in class AbstractEvaluationMetric

Returns:

the names of the metric

getStatistic

public double getStatistic(String statName)

Get the value of the named statistic, should be "Variation of Information".

Specified by:

getStatistic in class AbstractEvaluationMetric

Parameters:

statName - the name of the statistic, should be "Variation of Information"

Returns:

the computed statistic

Throws:

AbstractEvaluationMetric.UnknownStatisticException - if the statistic name is not "Variation of Information"

updateStatsForClassifier

public void updateStatsForClassifier(double[] predictedDistribution,
                            Instance instance)
                              throws Exception

Not used. This method is required to conform to the InformationTheoreticEvaluationMetric interface, but not implemented.

Specified by:

updateStatsForClassifier in interface InformationTheoreticEvaluationMetric

Throws:

Exception

updateStatsForPredictor

public void updateStatsForPredictor(double predictedValue,
                           Instance instance)
                             throws Exception

Not used. This method is required to conform to the InformationTheoreticEvaluationMetric interface, but not implemented.

Specified by:

updateStatsForPredictor in interface InformationTheoreticEvaluationMetric

Throws:

Exception

updateStatsForConditionalDensityEstimator

public void updateStatsForConditionalDensityEstimator(ConditionalDensityEstimator classifier,
                                             Instance classMissing,
                                             double classValue)
                                               throws Exception

Not used. This method is required to conform to the InformationTheoreticEvaluationMetric interface, but not implemented.

Specified by:

updateStatsForConditionalDensityEstimator in interface InformationTheoreticEvaluationMetric

Throws:

Exception

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Returns:

the technical information about this class