edu.stanford.nlp.sentiment

Class SentimentModel

java.lang.Object

edu.stanford.nlp.sentiment.SentimentModel

All Implemented Interfaces:

java.io.Serializable

public class SentimentModel
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix>	binaryClassification CxN+1, where N = size of word vectors, C is the number of classes
int	binaryClassificationSize How many elements a classification matrix has
TwoDimensionalMap<java.lang.String,java.lang.String,SimpleTensor>	binaryTensors 2Nx2NxN, where N is the size of the word vectors
int	binaryTensorSize How many elements the binary transformation tensors have
TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix>	binaryTransform Nx2N+1, where N is the size of the word vectors
int	binaryTransformSize How many elements a transformation matrix has
int	numBinaryMatrices Cached here for easy calculation of the model size; TwoDimensionalMap does not return that in O(1) time
int	numClasses How many classes the RNN is built to test against
int	numHid Dimension of hidden layers, size of word vectors, etc
int	numUnaryMatrices Cached here for easy calculation of the model size; TwoDimensionalMap does not return that in O(1) time
RNNOptions	op Will store various options specific to this model
java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix>	unaryClassification CxN+1, where N = size of word vectors, C is the number of classes
int	unaryClassificationSize How many elements a classification matrix has
java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix>	wordVectors Map from vocabulary words to word vectors.

Constructor Summary

Constructors

Constructor and Description
SentimentModel(RNNOptions op, java.util.List<Tree> trainingTrees) The traditional way of initializing an empty model suitable for training.
SentimentModel(TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix> binaryTransform, TwoDimensionalMap<java.lang.String,java.lang.String,SimpleTensor> binaryTensors, TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix> binaryClassification, java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix> unaryClassification, java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix> wordVectors, RNNOptions op)

Method Summary

Modifier and Type	Method and Description
java.lang.String	basicCategory(java.lang.String category)
org.ejml.simple.SimpleMatrix	getBinaryClassification(java.lang.String left, java.lang.String right)
SimpleTensor	getBinaryTensor(java.lang.String left, java.lang.String right)
org.ejml.simple.SimpleMatrix	getBinaryTransform(java.lang.String left, java.lang.String right)
org.ejml.simple.SimpleMatrix	getClassWForNode(Tree node)
SimpleTensor	getTensorForNode(Tree node)
org.ejml.simple.SimpleMatrix	getUnaryClassification(java.lang.String category)
java.lang.String	getVocabWord(java.lang.String word) Get the known vocabulary word associated with the given word.
org.ejml.simple.SimpleMatrix	getWForNode(Tree node)
org.ejml.simple.SimpleMatrix	getWordVector(java.lang.String word) Retrieve a learned word vector for the given word.
static SentimentModel	loadSerialized(java.lang.String path)
double[]	paramsToVector()
void	printParamInformation(int index)
void	saveSerialized(java.lang.String path)
java.lang.String	toString() Dumps *all* the matrices in a mostly readable format.
int	totalParamSize()
void	vectorToParams(double[] theta)

Methods inherited from class java.lang.Object

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

Field Detail

binaryTransform

public final TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix> binaryTransform

Nx2N+1, where N is the size of the word vectors

binaryTensors

public final TwoDimensionalMap<java.lang.String,java.lang.String,SimpleTensor> binaryTensors

2Nx2NxN, where N is the size of the word vectors

binaryClassification

public final TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix> binaryClassification

CxN+1, where N = size of word vectors, C is the number of classes

unaryClassification

public final java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix> unaryClassification

CxN+1, where N = size of word vectors, C is the number of classes

wordVectors

public java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix> wordVectors

Map from vocabulary words to word vectors.

See Also:

getWordVector(String)

numClasses

public final int numClasses

How many classes the RNN is built to test against

numHid

public final int numHid

Dimension of hidden layers, size of word vectors, etc

numBinaryMatrices

public final int numBinaryMatrices

Cached here for easy calculation of the model size; TwoDimensionalMap does not return that in O(1) time

binaryTransformSize

public final int binaryTransformSize

How many elements a transformation matrix has

binaryTensorSize

public final int binaryTensorSize

How many elements the binary transformation tensors have

binaryClassificationSize

public final int binaryClassificationSize

How many elements a classification matrix has

numUnaryMatrices

public final int numUnaryMatrices

Cached here for easy calculation of the model size; TwoDimensionalMap does not return that in O(1) time

unaryClassificationSize

public final int unaryClassificationSize

How many elements a classification matrix has

op

public final RNNOptions op

Will store various options specific to this model

Constructor Detail

SentimentModel

public SentimentModel(TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix> binaryTransform,
                      TwoDimensionalMap<java.lang.String,java.lang.String,SimpleTensor> binaryTensors,
                      TwoDimensionalMap<java.lang.String,java.lang.String,org.ejml.simple.SimpleMatrix> binaryClassification,
                      java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix> unaryClassification,
                      java.util.Map<java.lang.String,org.ejml.simple.SimpleMatrix> wordVectors,
                      RNNOptions op)

SentimentModel

public SentimentModel(RNNOptions op,
                      java.util.List<Tree> trainingTrees)

The traditional way of initializing an empty model suitable for training.

Method Detail

toString

public java.lang.String toString()

Dumps *all* the matrices in a mostly readable format.

Overrides:

toString in class java.lang.Object

totalParamSize

public int totalParamSize()

paramsToVector

public double[] paramsToVector()

vectorToParams

public void vectorToParams(double[] theta)

getWForNode

public org.ejml.simple.SimpleMatrix getWForNode(Tree node)

getTensorForNode

public SimpleTensor getTensorForNode(Tree node)

getClassWForNode

public org.ejml.simple.SimpleMatrix getClassWForNode(Tree node)

getWordVector

public org.ejml.simple.SimpleMatrix getWordVector(java.lang.String word)

Retrieve a learned word vector for the given word. If the word is OOV, returns a vector associated with an <unk> term.

getVocabWord

public java.lang.String getVocabWord(java.lang.String word)

Get the known vocabulary word associated with the given word.

Returns:

The form of the given word known by the model, or UNKNOWN_WORD if this word has not been observed

basicCategory

public java.lang.String basicCategory(java.lang.String category)

getUnaryClassification

public org.ejml.simple.SimpleMatrix getUnaryClassification(java.lang.String category)

getBinaryClassification

public org.ejml.simple.SimpleMatrix getBinaryClassification(java.lang.String left,
                                                            java.lang.String right)

getBinaryTransform

public org.ejml.simple.SimpleMatrix getBinaryTransform(java.lang.String left,
                                                       java.lang.String right)

getBinaryTensor

public SimpleTensor getBinaryTensor(java.lang.String left,
                                    java.lang.String right)

saveSerialized

public void saveSerialized(java.lang.String path)

loadSerialized

public static SentimentModel loadSerialized(java.lang.String path)

printParamInformation

public void printParamInformation(int index)