org.carrot2.output.metrics

Class NormalizedMutualInformationMetricDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.output.metrics.IdealPartitioningBasedMetricDescriptor.AttributeBuilder

org.carrot2.output.metrics.NormalizedMutualInformationMetricDescriptor.AttributeBuilder

Enclosing class:

NormalizedMutualInformationMetricDescriptor

public static class NormalizedMutualInformationMetricDescriptor.AttributeBuilder
extends IdealPartitioningBasedMetricDescriptor.AttributeBuilder

Attribute map builder for the NormalizedMutualInformationMetric component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	map The attribute map populated by this builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NormalizedMutualInformationMetricDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
NormalizedMutualInformationMetricDescriptor.AttributeBuilder	clusters(List<Cluster> value)
NormalizedMutualInformationMetricDescriptor.AttributeBuilder	documents(List<Document> value)
NormalizedMutualInformationMetricDescriptor.AttributeBuilder	enabled(boolean value) Calculate Normalized Mutual Information metric.
Double	normalizedMutualInformation() Normalized Mutual Information of the whole cluster set.

Methods inherited from class org.carrot2.output.metrics.IdealPartitioningBasedMetricDescriptor.AttributeBuilder

partitionIdFieldName

Methods inherited from class java.lang.Object

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

Field Detail

map

public final Map<String,Object> map

The attribute map populated by this builder.

Constructor Detail

NormalizedMutualInformationMetricDescriptor.AttributeBuilder

protected NormalizedMutualInformationMetricDescriptor.AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

normalizedMutualInformation

public Double normalizedMutualInformation()

Normalized Mutual Information of the whole cluster set.

See Also:

NormalizedMutualInformationMetric.normalizedMutualInformation

documents

public NormalizedMutualInformationMetricDescriptor.AttributeBuilder documents(List<Document> value)

See Also:

NormalizedMutualInformationMetric.documents

clusters

public NormalizedMutualInformationMetricDescriptor.AttributeBuilder clusters(List<Cluster> value)

See Also:

NormalizedMutualInformationMetric.clusters

enabled

public NormalizedMutualInformationMetricDescriptor.AttributeBuilder enabled(boolean value)

Calculate Normalized Mutual Information metric.

See Also:

NormalizedMutualInformationMetric.enabled