edu.ucla.sspace.beagle

Class Beagle

java.lang.Object

edu.ucla.sspace.beagle.Beagle

All Implemented Interfaces:

SemanticSpace

public class Beagle
extends Object
implements SemanticSpace

An implementation of the Beagle Semantic Space model. This implementation is based on

Jones, M. N., Mewhort, D. J.L. (2007). Representing Word Meaning and Order Information in a Composite Holographic Lexicon. Psychological Review 114, 1-37. Available here

For every word, a unique random index vector is created, where the vector has some large dimension (by default 512), with each entry in the vector being from a random gaussian distribution. The holographic meaning of a word is updated by first adding the sum of index vectors for all the words in a sliding window centered around the target term. Additionally a sum of convolutions of several n-grams is added to the holographic meaning. The main functionality of this class can be found in the IndexBuilder class.

Author:

Keith Stevens

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Beagle.SemanticType

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAGLE_SSPACE_NAME The Semantic Space name for Beagle
static int	CONTEXT_SIZE The full context size used when scanning the corpus.

Constructor Summary

Constructors

Constructor and Description
Beagle(int vectorSize, Beagle.SemanticType semanticType, Map<String,DoubleVector> vectorMap)
Beagle(int vectorSize, Map<String,DoubleVector> vectorMap)

Method Summary

Methods

Modifier and Type	Method and Description
String	getSpaceName() Returns a unique string describing the name and configuration of this algorithm.
DoubleVector	getVector(String term) Returns the semantic vector for the provided word.
int	getVectorLength() Returns the length of vectors in this semantic space.
Set<String>	getWords() Returns the set of words that are represented in this semantic space.
void	processDocument(BufferedReader document) Processes the contents of the provided file as a document.
void	processSpace(Properties properties) No processing is performed on the holographs.

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_SIZE

public static final int CONTEXT_SIZE

The full context size used when scanning the corpus. This is the total number of words considered in the context.

See Also:

Constant Field Values

BEAGLE_SSPACE_NAME

public static final String BEAGLE_SSPACE_NAME

The Semantic Space name for Beagle

See Also:

Constant Field Values

Constructor Detail

Beagle

public Beagle(int vectorSize,
      Map<String,DoubleVector> vectorMap)

Beagle

public Beagle(int vectorSize,
      Beagle.SemanticType semanticType,
      Map<String,DoubleVector> vectorMap)

Method Detail

getWords

public Set<String> getWords()

Returns the set of words that are represented in this semantic space.

Specified by:

getWords in interface SemanticSpace

Returns:

the set of words that are represented in this semantic space.

getVector

public DoubleVector getVector(String term)

Returns the semantic vector for the provided word.

Specified by:

getVector in interface SemanticSpace

Parameters:

term - a word that may be in the semantic space

Returns:

The Vector for the provided word or null if the word was not in the space.

getSpaceName

public String getSpaceName()

Returns a unique string describing the name and configuration of this algorithm. Any configurable parameters that would affect the resulting semantic space should be expressed as a part of this name.

Specified by:

getSpaceName in interface SemanticSpace

getVectorLength

public int getVectorLength()

Returns the length of vectors in this semantic space. Implementations are left free to define whether the returned value is valid before processSpace is called.

Specified by:

getVectorLength in interface SemanticSpace

processDocument

public void processDocument(BufferedReader document)
                     throws IOException

Processes the contents of the provided file as a document.

Specified by:

processDocument in interface SemanticSpace

Parameters:

document - a reader that allows access to the text of the document

Throws:

IOException - if any error occurs while reading the document

processSpace

public void processSpace(Properties properties)

No processing is performed on the holographs.

Specified by:

processSpace in interface SemanticSpace

Parameters:

properties - a set of properties and values that may be used to configure any exposed parameters of the algorithm.