edu.ucla.sspace.mains

Class StructuredVectorSpaceMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.DependencyGenericMain

edu.ucla.sspace.mains.StructuredVectorSpaceMain

public class StructuredVectorSpaceMain
extends DependencyGenericMain

NOTE: NOT MEANT TO BE PART OF WORDSI-UPDATE. An executable class for running StructuredVectorSpace (StructuredVectorSpace) from the command line. This class takes in several command line arguments.

• Required (at least one of):
  • -d, --docFile=FILE[,FILE...] a file where each line is a document. This is the preferred input format for large corpora
  • -f, --fileList=FILE[,FILE...] a list of document files where each file is specified on its own line.
• Algorithm Options:
  options.addOption('G', "configFile", "XML configuration file for the format of a " + "dependency parse",
  • -a, --pathAcceptor=CLASSNAME Specifies the DependencyPathAcceptor to use while accepting or rejecting DependencyPaths.
  • -W, --pathWeighter=CLASSNAME Specifies the DependencyPathWeighter to use while scoring DependencyPaths.
• Program Options:
  • -G, --configFile=config.xml Specifies a configuration file for specifying the ordering of the malth styled dependency parse trees.
  • -o, --outputFormat=text|binary} Specifies the output formatting to use when generating the semantic space (.sspace) file. See SemanticSpaceUtils for format details.
  • -t, --threads=INT how many threads to use when processing the documents. The default is one per core.
  • -w, --overwrite=BOOL specifies whether to overwrite the existing output files. The default is true. If set to false, a unique integer is inserted into the file name.
  • -v, --verbose specifies whether to print runtime information to standard out

An invocation will produce one file as output structued-vector-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 structued-vector-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 class is desgined to run multi-threaded and performs well with one thread per core, which is the default setting.

Author:

Keith Stevens

See Also:

StructuredVectorSpace

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.
protected 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.
static void	main(String[] args)
protected Properties	setupProperties() Returns the Properties object that will be used when calling SemanticSpace.processSpace(Properties).

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

addDocIterators, addFileIterators, setupDependencyExtractor, usage

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

addCorpusReaderIterators, getAlgorithmSpecifics, getDocumentIterator, handleExtraOptions, loadValidTermSet, parseDocumentsMultiThreaded, parseDocumentsSingleThreaded, postProcessing, processDocumentsAndSpace, run, saveSSpace, setupOptions, verbose, verbose

Methods inherited from class java.lang.Object

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

Method Detail

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 DependencyGenericMain

Parameters:

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

See Also:

GenericMain.handleExtraOptions()

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

getSpace

protected 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

setupProperties

protected Properties setupProperties()

Returns the Properties object that will be used when calling SemanticSpace.processSpace(Properties). Subclasses should override this method if they need to specify additional properties for the space. This method will be called once before GenericMain.getSpace().

Overrides:

setupProperties in class GenericMain

Returns:

the Properties used for processing the semantic space.

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