edu.ucla.sspace.mains

Class BeagleMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.BeagleMain

public class BeagleMain
extends GenericMain

An executable class for running Beagle from the command line. This class takes in several command line arguments.

• --dimensions=<int> how many dimensions to use for the Beagle vectors. 2048 is the default value.

An invocation will produce one file as output beagle-semantic-space.sspace. If overwrite was set to true, this file will be replaced for each new semantic space. Otherwise, a new output file of the format beagle-semantic-space<number>.sspace will be created, where <number> is a unique identifier for that program's invocation. The output file will be placed in the directory specified on the command line.

This main will run with with multiple threads by default.

Author:

Keith Stevens

See Also:

Beagle

Field Summary

Fields inherited from class edu.ucla.sspace.mains.GenericMain

argOptions, EXT, isMultiThreaded, verbose

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtraOptions(ArgOptions options) Adds options to the provided ArgOptions instance, which will be used to parse the command line.
SemanticSpace	getSpace() Returns the SemanticSpace that will be used for processing.
protected SemanticSpaceIO.SSpaceFormat	getSpaceFormat() Returns the format in which the finished SemanticSpace should be saved.
void	handleExtraOptions() Once the command line has been parsed, allows the subclasses to perform additional steps based on class-specific options.
static void	main(String[] args)
protected void	postProcessing() Allows subclasses to interact with the SemanticSpace after the space has finished processing all of the text.

Methods inherited from class edu.ucla.sspace.mains.GenericMain

addCorpusReaderIterators, addDocIterators, addFileIterators, getAlgorithmSpecifics, getDocumentIterator, loadValidTermSet, parseDocumentsMultiThreaded, parseDocumentsSingleThreaded, processDocumentsAndSpace, run, saveSSpace, setupOptions, setupProperties, usage, verbose, verbose

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)

addExtraOptions

public void addExtraOptions(ArgOptions options)

Adds options to the provided ArgOptions instance, which will be used to parse the command line. This method allows subclasses the ability to add extra command line options.

Overrides:

addExtraOptions in class GenericMain

Parameters:

options - the ArgOptions object which more main specific options can be added to.

See Also:

GenericMain.handleExtraOptions()

handleExtraOptions

public void handleExtraOptions()

Once the command line has been parsed, allows the subclasses to perform additional steps based on class-specific options. This method will be called before getSpace.

Overrides:

handleExtraOptions in class GenericMain

See Also:

GenericMain.addExtraOptions(ArgOptions)

postProcessing

protected void postProcessing()

Allows subclasses to interact with the SemanticSpace after the space has finished processing all of the text.

Overrides:

postProcessing in class GenericMain

getSpace

public SemanticSpace getSpace()

Returns the SemanticSpace that will be used for processing. This method is guaranteed to be called after the command line arguments have been parsed, so the contents of GenericMain.argOptions are valid.

Specified by:

getSpace in class GenericMain

getSpaceFormat

protected SemanticSpaceIO.SSpaceFormat getSpaceFormat()

Returns the format in which the finished SemanticSpace should be saved. Subclasses should override this function if they want to specify a specific format that is most suited for their space, when one is not manually specified by the user.

Overrides:

getSpaceFormat in class GenericMain

Returns:

the format in which the semantic space will be saved