edu.stanford.nlp.parser.common

Class ParserGrammar

java.lang.Object

edu.stanford.nlp.parser.common.ParserGrammar

All Implemented Interfaces:

java.util.function.Function<List<? extends HasWord>,Tree>

Direct Known Subclasses:

LexicalizedParser, ShiftReduceParser

public abstract class ParserGrammar
extends Object
implements java.util.function.Function<List<? extends HasWord>,Tree>

An interface for the classes which store the data for a parser. Objects which inherit this interface have a way to produce ParserQuery objects, have a general Options object, and return a list of Evals to perform on a parser. This helps classes such as EvaluateTreebank analyze the performance of a parser. TODO: it would be nice to actually make this an interface again. Perhaps Java 8 will allow that

Author:

John Bauer

Constructor Summary

Constructors

Constructor and Description
ParserGrammar()

Method Summary

Modifier and Type	Method and Description
Tree	apply(List<? extends HasWord> words) Parses the list of HasWord.
abstract String[]	defaultCoreNLPFlags() Returns a set of options which should be set by default when used in corenlp.
abstract List<Eval>	getExtraEvals() Returns a list of extra Eval objects to use when scoring the parser.
abstract Options	getOp()
abstract List<ParserQueryEval>	getParserQueryEvals() Return a list of Eval-style objects which care about the whole ParserQuery, not just the finished tree
abstract TreebankLangParserParams	getTLPParams()
List<CoreLabel>	lemmatize(List<? extends HasWord> tokens) Only works on English, as it is hard coded for using the Morphology class, which is English-only
List<CoreLabel>	lemmatize(String sentence)
static ParserGrammar	loadModel(String path, String... extraFlags)
java.util.function.Function<List<? extends HasWord>,List<TaggedWord>>	loadTagger()
abstract Tree	parse(List<? extends HasWord> words) Parses the list of HasWord.
Tree	parse(String sentence) Will parse the text in sentence as if it represented a single sentence by first processing it with a tokenizer.
abstract ParserQuery	parserQuery()
abstract boolean	requiresTags() The model requires text to be pretagged
abstract void	setOptionFlags(String... flags)
List<? extends HasWord>	tokenize(String sentence) Tokenize the text using the parser's tokenizer
abstract TreebankLanguagePack	treebankLanguagePack()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

ParserGrammar

public ParserGrammar()

Method Detail

parserQuery

public abstract ParserQuery parserQuery()

apply

public Tree apply(List<? extends HasWord> words)

Parses the list of HasWord. If the parse fails for some reason, an X tree is returned instead of barfing.

Specified by:

apply in interface java.util.function.Function<List<? extends HasWord>,Tree>

Parameters:

words - The input sentence (a List of words)

Returns:

A Tree that is the parse tree for the sentence. If the parser fails, a new Tree is synthesized which attaches all words to the root.

tokenize

public List<? extends HasWord> tokenize(String sentence)

Tokenize the text using the parser's tokenizer

parse

public Tree parse(String sentence)

Will parse the text in sentence as if it represented a single sentence by first processing it with a tokenizer.

loadTagger

public java.util.function.Function<List<? extends HasWord>,List<TaggedWord>> loadTagger()

lemmatize

public List<CoreLabel> lemmatize(String sentence)

lemmatize

public List<CoreLabel> lemmatize(List<? extends HasWord> tokens)

Only works on English, as it is hard coded for using the Morphology class, which is English-only

parse

public abstract Tree parse(List<? extends HasWord> words)

Parses the list of HasWord. If the parse fails for some reason, an X tree is returned instead of barfing.

Parameters:

words - The input sentence (a List of words)

Returns:

A Tree that is the parse tree for the sentence. If the parser fails, a new Tree is synthesized which attaches all words to the root.

getExtraEvals

public abstract List<Eval> getExtraEvals()

Returns a list of extra Eval objects to use when scoring the parser.

getParserQueryEvals

public abstract List<ParserQueryEval> getParserQueryEvals()

Return a list of Eval-style objects which care about the whole ParserQuery, not just the finished tree

getOp

public abstract Options getOp()

getTLPParams

public abstract TreebankLangParserParams getTLPParams()

treebankLanguagePack

public abstract TreebankLanguagePack treebankLanguagePack()

defaultCoreNLPFlags

public abstract String[] defaultCoreNLPFlags()

Returns a set of options which should be set by default when used in corenlp. For example, the English PCFG/RNN models want -retainTmpSubcategories, and the ShiftReduceParser models may want -beamSize 4 depending on how they were trained.
TODO: right now completely hardcoded, should be settable as a training time option

setOptionFlags

public abstract void setOptionFlags(String... flags)

requiresTags

public abstract boolean requiresTags()

The model requires text to be pretagged

loadModel

public static ParserGrammar loadModel(String path,
                                      String... extraFlags)