edu.stanford.nlp.parser.lexparser
Class EnglishTreebankParserParams

java.lang.Object
  edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams
      edu.stanford.nlp.parser.lexparser.EnglishTreebankParserParams

All Implemented Interfaces:

TreebankLangParserParams, TreebankFactory, java.io.Serializable

public class EnglishTreebankParserParams
extends AbstractTreebankParserParams

Parser parameters for the Penn English Treebank (WSJ, Brown, Switchboard).

Author:

Roger Levy, Christopher Manning

See Also:

Serialized Form

Nested Class Summary

protected class	EnglishTreebankParserParams.EnglishSubcategoryStripper
static class	EnglishTreebankParserParams.EnglishTest
static class	EnglishTreebankParserParams.EnglishTrain

Nested classes/interfaces inherited from class edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

AbstractTreebankParserParams.AnnotatePunctuationFunction, AbstractTreebankParserParams.RemoveGFSubcategoryStripper, AbstractTreebankParserParams.SubcategoryStripper

Field Summary

Fields inherited from class edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

evalGF, inputEncoding, outputEncoding, tlp

Constructor Summary

EnglishTreebankParserParams()

Method Summary

TreeTransformer	collinizer() The tree transformer used to produce trees for evaluation.
TreeTransformer	collinizerEvalb() the tree transformer used to produce trees for evaluation.
java.util.List<Word>	defaultTestSentence() Return a default sentence for the language (for testing)
DiskTreebank	diskTreebank() Allows you to read in trees from the source you want.
void	display() display language-specific settings
GrammaticalStructure	getGrammaticalStructure(Tree t, Filter<java.lang.String> filter, HeadFinder hf) Build a GrammaticalStructure from a Tree.
HeadFinder	headFinder() The HeadFinder to use for your treebank.
Lexicon	lex(Options op, Index<java.lang.String> wordIndex, Index<java.lang.String> tagIndex) Vends a Lexicon object suitable to the particular language/treebank combination of interest.
static void	main(java.lang.String[] args)
MemoryTreebank	memoryTreebank() Allows you to read in trees from the source you want.
java.io.PrintWriter	pw(java.io.OutputStream o) The PrintWriter used to print output to OutputStream o.
java.util.List<GrammaticalStructure>	readGrammaticalStructureFromFile(java.lang.String filename) Returns a function which reads the given filename and turns its content in a list of GrammaticalStructures.
int	setOptionFlag(java.lang.String[] args, int i) Set language-specific options according to flags.
java.lang.String[]	sisterSplitters() Returns the splitting strings used for selective splits.
TreeTransformer	subcategoryStripper() Returns a TreeTransformer appropriate to the Treebank which can be used to remove functional tags (such as "-TMP") from categories.
MemoryTreebank	testMemoryTreebank() returns a MemoryTreebank appropriate to the testing treebank source
Tree	transformTree(Tree t, Tree root) This method does language-specific tree transformations such as annotating particular nodes with language-relevant features.
TreebankLanguagePack	treebankLanguagePack() contains Treebank-specific (but not parser-specific) info such as what is punctuation, and also information about the structure of labels
TreeReaderFactory	treeReaderFactory() Makes appropriate TreeReaderFactory with all options specified
HeadFinder	typedDependencyHeadFinder() The HeadFinder to use when extracting typed dependencies.

Methods inherited from class edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

dependencyGrammarExtractor, dependencyObjectify, getInputEncoding, getOutputEncoding, isEvalGF, MLEDependencyGrammarSmoothingParams, parsevalObjectify, parsevalObjectify, ppAttachmentEval, processHeadWord, pw, setEvalGF, setEvaluateGrammaticalFunctions, setInputEncoding, setOutputEncoding, setupForEval, treebank, treeTokenizerFactory, typedDependencyClasser, typedDependencyObjectify, unorderedTypedDependencyObjectify, unorderedUntypedDependencyObjectify, untypedDependencyObjectify

Methods inherited from class java.lang.Object

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

Constructor Detail

EnglishTreebankParserParams

public EnglishTreebankParserParams()

Method Detail

headFinder

public HeadFinder headFinder()

Description copied from class: AbstractTreebankParserParams

The HeadFinder to use for your treebank.

Specified by:

headFinder in interface TreebankLangParserParams

Specified by:

headFinder in class AbstractTreebankParserParams

typedDependencyHeadFinder

public HeadFinder typedDependencyHeadFinder()

Description copied from class: AbstractTreebankParserParams

The HeadFinder to use when extracting typed dependencies.

Specified by:

typedDependencyHeadFinder in interface TreebankLangParserParams

Specified by:

typedDependencyHeadFinder in class AbstractTreebankParserParams

diskTreebank

public DiskTreebank diskTreebank()

Allows you to read in trees from the source you want. It's the responsibility of treeReaderFactory() to deal properly with character-set encoding of the input. It also is the responsibility of tr to properly normalize trees.

Specified by:

diskTreebank in interface TreebankLangParserParams

Specified by:

diskTreebank in class AbstractTreebankParserParams

memoryTreebank

public MemoryTreebank memoryTreebank()

Allows you to read in trees from the source you want. It's the responsibility of treeReaderFactory() to deal properly with character-set encoding of the input. It also is the responsibility of tr to properly normalize trees.

Specified by:

memoryTreebank in interface TreebankLangParserParams

Specified by:

memoryTreebank in class AbstractTreebankParserParams

treeReaderFactory

public TreeReaderFactory treeReaderFactory()

Makes appropriate TreeReaderFactory with all options specified

Returns:

A factory that vends an appropriate TreeReader

testMemoryTreebank

public MemoryTreebank testMemoryTreebank()

returns a MemoryTreebank appropriate to the testing treebank source

Specified by:

testMemoryTreebank in interface TreebankLangParserParams

Overrides:

testMemoryTreebank in class AbstractTreebankParserParams

collinizer

public TreeTransformer collinizer()

The tree transformer used to produce trees for evaluation. It will be applied both to the parser output and the gold tree.

Specified by:

collinizer in interface TreebankLangParserParams

Specified by:

collinizer in class AbstractTreebankParserParams

Returns:

A TreeTransformer that performs adjustments to trees to delete or equivalence class things not evaluated in the parser performance evaluation.

collinizerEvalb

public TreeTransformer collinizerEvalb()

Description copied from class: AbstractTreebankParserParams

the tree transformer used to produce trees for evaluation. Will be applied both to the parse output tree and to the gold tree. Should strip punctuation and maybe do some other things. The evalb version should strip some more stuff off. (finish this doc!)

Specified by:

collinizerEvalb in interface TreebankLangParserParams

Specified by:

collinizerEvalb in class AbstractTreebankParserParams

treebankLanguagePack

public TreebankLanguagePack treebankLanguagePack()

contains Treebank-specific (but not parser-specific) info such as what is punctuation, and also information about the structure of labels

Specified by:

treebankLanguagePack in interface TreebankLangParserParams

Overrides:

treebankLanguagePack in class AbstractTreebankParserParams

pw

public java.io.PrintWriter pw(java.io.OutputStream o)

The PrintWriter used to print output to OutputStream o. It's the responsibility of pw to deal properly with character encodings for the relevant treebank.

Specified by:

pw in interface TreebankLangParserParams

Overrides:

pw in class AbstractTreebankParserParams

lex

public Lexicon lex(Options op,
                   Index<java.lang.String> wordIndex,
                   Index<java.lang.String> tagIndex)

Description copied from interface: TreebankLangParserParams

Vends a Lexicon object suitable to the particular language/treebank combination of interest.

Specified by:

lex in interface TreebankLangParserParams

Overrides:

lex in class AbstractTreebankParserParams

Parameters:

op - Options as to how the Lexicon behaves

Returns:

A Lexicon, constructed based on the given option

sisterSplitters

public java.lang.String[] sisterSplitters()

Description copied from class: AbstractTreebankParserParams

Returns the splitting strings used for selective splits.

Specified by:

sisterSplitters in interface TreebankLangParserParams

Specified by:

sisterSplitters in class AbstractTreebankParserParams

Returns:

An array containing ancestor-annotated Strings: categories should be split according to these ancestor annotations.

subcategoryStripper

public TreeTransformer subcategoryStripper()

Returns a TreeTransformer appropriate to the Treebank which can be used to remove functional tags (such as "-TMP") from categories.

Specified by:

subcategoryStripper in interface TreebankLangParserParams

Overrides:

subcategoryStripper in class AbstractTreebankParserParams

transformTree

public Tree transformTree(Tree t,
                          Tree root)

This method does language-specific tree transformations such as annotating particular nodes with language-relevant features. Such parameterizations should be inside the specific TreebankLangParserParams class. This method is recursively applied to each node in the tree (depth first, left-to-right), so you shouldn't write this method to apply recursively to tree members. This method is allowed to (and in some cases does) destructively change the input tree t. It changes both labels and the tree shape.

Specified by:

transformTree in interface TreebankLangParserParams

Specified by:

transformTree in class AbstractTreebankParserParams

Parameters:

t - The input tree (with non-language-specific annotation already done, so you need to strip back to basic categories)

root - The root of the current tree (can be null for words)

Returns:

The fully annotated tree node (with daughters still as you want them in the final result)

display

public void display()

Description copied from class: AbstractTreebankParserParams

display language-specific settings

Specified by:

display in interface TreebankLangParserParams

Specified by:

display in class AbstractTreebankParserParams

setOptionFlag

public int setOptionFlag(java.lang.String[] args,
                         int i)

Set language-specific options according to flags. This routine should process the option starting in args[i] (which might potentially be several arguments long if it takes arguments). It should return the index after the last index it consumed in processing. In particular, if it cannot process the current option, the return value should be i.

Specified by:

setOptionFlag in interface TreebankLangParserParams

Overrides:

setOptionFlag in class AbstractTreebankParserParams

Parameters:

args - Array of command line arguments

i - Index in command line arguments to try to process as an option

Returns:

The index of the item after arguments processed as part of this command line option.

defaultTestSentence

public java.util.List<Word> defaultTestSentence()

Return a default sentence for the language (for testing)

Returns:

A default sentence of the language

readGrammaticalStructureFromFile

public java.util.List<GrammaticalStructure> readGrammaticalStructureFromFile(java.lang.String filename)

Description copied from interface: TreebankLangParserParams

Returns a function which reads the given filename and turns its content in a list of GrammaticalStructures. Will throw UnsupportedOperationException if the language doesn't support dependencies or GrammaticalStructures.

Specified by:

readGrammaticalStructureFromFile in interface TreebankLangParserParams

Overrides:

readGrammaticalStructureFromFile in class AbstractTreebankParserParams

getGrammaticalStructure

public GrammaticalStructure getGrammaticalStructure(Tree t,
                                                    Filter<java.lang.String> filter,
                                                    HeadFinder hf)

Description copied from interface: TreebankLangParserParams

Build a GrammaticalStructure from a Tree. Throws UnsupportedOperationException if the language doesn't support dependencies or GrammaticalStructures.

Specified by:

getGrammaticalStructure in interface TreebankLangParserParams

Overrides:

getGrammaticalStructure in class AbstractTreebankParserParams

main

public static void main(java.lang.String[] args)