eus.ixa.ixa.pipe.ml.document

Interface DocumentClassifier

All Known Implementing Classes:

DocumentClassifierME

public interface DocumentClassifier

Interface for classes which classifies documents.

Method Summary

Modifier and Type	Method and Description
String	classify(String[] text) Classifies the given text, provided in separate tokens.
double[]	classifyProb(String[] text) Classifies the given text, provided in separate tokens.
void	clearFeatureData() Informs the feature generator that the context of the data in the context (typically a document) is no longer valid.
String	getAllLabels(double[] results) Get the label associated with the given probabilities.
String	getBestLabel(double[] outcome) Get the best label from previously generated outcome probabilities.
int	getIndex(String label) Get the index of a certain label.
String	getLabel(int index) Get the category at a given index.
int	getNumberOfLabels() get the number of found labels.
Map<String,Double>	scoreMap(String[] text) Returns a map in which the key is the label name and the value is the score.
SortedMap<Double,Set<String>>	sortedScoreMap(String[] text) Get a map of the scores sorted in ascending order together with their associated labels.

Method Detail

classify

String classify(String[] text)

Classifies the given text, provided in separate tokens.

Parameters:

text - the tokens of text to classify

Returns:

the best label found

classifyProb

double[] classifyProb(String[] text)

Classifies the given text, provided in separate tokens.

Parameters:

text - the tokens of text to classify

Returns:

per category probabilities

getBestLabel

String getBestLabel(double[] outcome)

Get the best label from previously generated outcome probabilities.

Parameters:

outcome - a vector of outcome probabilities

Returns:

the best label in a String

getIndex

int getIndex(String label)

Get the index of a certain label.

Parameters:

label - the label

Returns:

an index

getLabel

String getLabel(int index)

Get the category at a given index.

Parameters:

index - the index

Returns:

a label

getNumberOfLabels

int getNumberOfLabels()

get the number of found labels.

Returns:

the number of labels

getAllLabels

String getAllLabels(double[] results)

Get the label associated with the given probabilities.

Parameters:

results - the probabilities of each label

Returns:

the name of the outcome

scoreMap

Map<String,Double> scoreMap(String[] text)

Returns a map in which the key is the label name and the value is the score.

Parameters:

text - the input text to classify

Returns:

a map with the score as a key. The value is a Set of labels with the score.

sortedScoreMap

SortedMap<Double,Set<String>> sortedScoreMap(String[] text)

Get a map of the scores sorted in ascending order together with their associated labels. Many labels can have the same score, hence the Set as value.

Parameters:

text - the input text to classify

Returns:

a map with the score as a key. The value is a Set of labels with their score.

clearFeatureData

void clearFeatureData()

Informs the feature generator that the context of the data in the context (typically a document) is no longer valid.