org.carrot2.output.metrics

Class NormalizedMutualInformationMetric

java.lang.Object

org.carrot2.output.metrics.NormalizedMutualInformationMetric

All Implemented Interfaces:

IClusteringMetric

@Bindable
public class NormalizedMutualInformationMetric
extends Object

Computes Normalized Mutual Information (NMI) metric for the cluster set.

Metrics will be calculated only if all input documents have non-blank Document.PARTITIONS.

Field Summary

Fields

Modifier and Type	Field and Description
List<Cluster>	clusters
List<Document>	documents
boolean	enabled Calculate Normalized Mutual Information metric.
Double	normalizedMutualInformation Normalized Mutual Information of the whole cluster set.
String	partitionIdFieldName Partition id field name.

Constructor Summary

Constructors

Constructor and Description
NormalizedMutualInformationMetric()

Method Summary

Methods

Modifier and Type	Method and Description
void	calculate() Triggers calculation of the metric.
boolean	isEnabled() Return true if this metric should be calculated.

Methods inherited from class java.lang.Object

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

Field Detail

normalizedMutualInformation

@Processing
@Output
@Attribute
public Double normalizedMutualInformation

Normalized Mutual Information of the whole cluster set.

documents

@Processing
@Input
@Attribute(key="documents")
public List<Document> documents

clusters

@Processing
@Input
@Attribute(key="clusters")
public List<Cluster> clusters

enabled

@Processing
@Input
@Attribute
public boolean enabled

Calculate Normalized Mutual Information metric.

partitionIdFieldName

@Input
@Processing
@Attribute
public String partitionIdFieldName

Partition id field name.

Constructor Detail

NormalizedMutualInformationMetric

public NormalizedMutualInformationMetric()

Method Detail

calculate

public void calculate()

Description copied from interface: IClusteringMetric

Triggers calculation of the metric. All Processing Input attributes will have been bound before a call to this method.

isEnabled

public boolean isEnabled()

Description copied from interface: IClusteringMetric

Return true if this metric should be calculated.