opennlp.tools.sentiment

Class SentimentME

java.lang.Object

opennlp.tools.sentiment.SentimentME

public class SentimentME
extends Object

Class for creating a maximum-entropy-based Sentiment Analysis model.

Field Summary

Fields

Modifier and Type	Field and Description
protected SentimentContextGenerator	contextGenerator
static String	CONTINUE
static int	DEFAULT_BEAM_SIZE
protected opennlp.tools.ml.model.SequenceClassificationModel<String>	model
static String	OTHER
static String	START

Constructor Summary

Constructors

Constructor and Description
SentimentME(SentimentModel sentModel) Constructor, initialises

Method Summary

Methods

Modifier and Type	Method and Description
String	getBestSentiment(double[] outcome) Returns the best chosen sentiment for the text predicted on
String	predict(String sentence) Makes a sentiment prediction
opennlp.tools.util.Span[]	predict2(String[] tokens) Makes a sentiment prediction by calling the helper method
opennlp.tools.util.Span[]	predict2(String[] tokens, String[][] additionalContext) Makes a sentiment prediction
double[]	probabilities(String[] text) Returns the analysis probabilities
static SentimentModel	train(String languageCode, opennlp.tools.util.ObjectStream<SentimentSample> samples, opennlp.tools.util.TrainingParameters trainParams, SentimentFactory factory) Trains a Sentiment Analysis model.

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

public static final String OTHER

See Also:

Constant Field Values

START

public static final String START

See Also:

Constant Field Values

CONTINUE

public static final String CONTINUE

See Also:

Constant Field Values

DEFAULT_BEAM_SIZE

public static final int DEFAULT_BEAM_SIZE

See Also:

Constant Field Values

contextGenerator

protected SentimentContextGenerator contextGenerator

model

protected opennlp.tools.ml.model.SequenceClassificationModel<String> model

Constructor Detail

SentimentME

public SentimentME(SentimentModel sentModel)

Constructor, initialises

Parameters:

sentModel - sentiment analysis model

Method Detail

train

public static SentimentModel train(String languageCode,
                   opennlp.tools.util.ObjectStream<SentimentSample> samples,
                   opennlp.tools.util.TrainingParameters trainParams,
                   SentimentFactory factory)
                            throws IOException

Trains a Sentiment Analysis model.

Parameters:

languageCode - the code for the language of the text, e.g. "en"

samples - the sentiment samples to be used

trainParams - parameters for training

factory - a Sentiment Analysis factory

Returns:

a Sentiment Analysis model

Throws:

IOException

predict

public String predict(String sentence)

Makes a sentiment prediction

Parameters:

sentence - the text to be analysed for its sentiment

Returns:

the predicted sentiment

getBestSentiment

public String getBestSentiment(double[] outcome)

Returns the best chosen sentiment for the text predicted on

Parameters:

outcome - the outcome

Returns:

the best sentiment

probabilities

public double[] probabilities(String[] text)

Returns the analysis probabilities

Parameters:

text - the text to categorize

predict2

public opennlp.tools.util.Span[] predict2(String[] tokens)

Makes a sentiment prediction by calling the helper method

Parameters:

tokens - the text to be analysed for its sentiment

Returns:

the prediction made by the helper method

predict2

public opennlp.tools.util.Span[] predict2(String[] tokens,
                                 String[][] additionalContext)

Makes a sentiment prediction

Parameters:

tokens - the text to be analysed for its sentiment

additionalContext - any required additional context

Returns:

the predictions