|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.stanford.nlp.tagger.maxent.MaxentTagger
public class MaxentTagger
The main class for users to run, train, and test the part of speech tagger. You can tag things through the Java API or from the command line. The two English taggers included in this distribution are:
MaxentTagger tagger = new MaxentTagger("models/left3words-wsj-0-18.tagger");
MaxentTagger tagger = new MaxentTagger(DEFAULT_NLP_GROUP_MODEL_PATH);
Sentence taggedSentence = tagger.tagSentence(Sentence sentence)
Sentence taggedSentence = tagger.apply(Sentence sentence)
List taggedList = tagger.process(List sentences)
String taggedString = tagger.tagString("Here's a tagged string.")
String taggedString = tagger.tagTokenizedString("Here 's a tagged string .")
The tagString
method uses the default tokenizer (PTBTokenizer).
If you wish to control tokenization, you may wish to call
tokenizeText(Reader, TokenizerFactory)
and then to call
process()
on the result.
java edu.stanford.nlp.tagger.maxent.MaxentTagger -genpropsThis gets you a default properties file with descriptions of each parameter you can set in your trained model. You can modify the properties file , or use the default options. To train, run:
java -mx1g edu.stanford.nlp.tagger.maxent.MaxentTagger -props myPropertiesFile.propswith the appropriate properties file specified; any argument you give in the properties file can also be specified on the command line. You must have specified a model using -model, either in the properties file or on the command line, as well as a file containing tagged words using -trainFile. Useful flags for controlling the amount of output are -verbose, which prints extra debugging information, and -verboseResults, which prints full information about intermediate results. -verbose defaults to false and -verboseResults defaults to true.
java edu.stanford.nlp.tagger.maxent.MaxentTagger -model <modelFile> -textFile <textfile>For testing (evaluating against tagged text):
java edu.stanford.nlp.tagger.maxent.MaxentTagger -model <modelFile> -testFile <testfile>You can use the same properties file as for training if you pass it in with the "-props" argument. The most important arguments for tagging (besides "model" and "file") are "tokenize" and "tokenizerFactory". See below for more details.
Parameters can be defined using a Properties file
(specified on the command-line with -prop
propFile),
or directly on the command line (by preceding their name with a minus sign
("-") to turn them into a flag. The following properties are recognized:
Property Name | Type | Default Value | Relevant Phase(s) | Description |
model | String | N/A | All | Path and filename where you would like to save the model (training) or where the model should be loaded from (testing, tagging). |
trainFile | String | N/A | Train |
Path to the file holding the training data; specifying this option puts the tagger in training mode. Only one of 'trainFile','testFile','textFile', and 'convertToSingleFile' may be specified. There are three formats possible. The first is a text file of tagged data, Each line is considered a separate sentence. In each sentence, words are separated by whitespace. Each word must have a tag, which is separated using the specified tagSeparator. This format is the default format. Another possible format is a file of Penn Treebank formatted tree files. Trees are loaded one at a time and the tagged words in the tree are used as the training sentence. To specify this format, preface the filename with " format=TREES, ". The final possible format is TSV files. To specify a TSV file, set trainFile to " format=TSV,wordColumn=x,tagColumn=y,filename ". Column numbers are indexed at 0, and sentences are separated with blank lines.
A file can be a different encoding than the tagger's default encoding by prefacing the filename with "encoding=ENC". Tree files can be fed through TreeTransformers and TreeNormalizers. To specify a transformer, preface the filename with "treeTransformer=CLASSNAME". To specify a normalizer, preface the filename with "treeNormalizer=CLASSNAME". You can also filter trees using a Filter<Tree>, which can be specified with "treeFilter=CLASSNAME". A specific range of trees to be used can be specified with treeRange=X-Y. Multiple parts of the range can be separated by : as opposed to the normal separator of , For example, one could use the argument "-treeRange=25-50:75-100". Multiple files can be specified by making a semicolon separated list of files. Each file can have its own format specifiers as above. You will note that none of , ; or = can be in filenames. |
testFile | String | N/A | Test | Path to the file holding the test data; specifying this option puts the tagger in testing mode. Only one of 'trainFile','testFile','textFile', and 'convertToSingleFile' may be specified. The same format as trainFile applies, but only one file can be specified. |
textFile | String | N/A | Tag | Path to the file holding the text to tag; specifying this option puts the tagger in tagging mode. Only one of 'trainFile','testFile','textFile', and 'convertToSingleFile' may be specified. No file reading options may be specified for textFile |
convertToSingleFile | String | N/A | N/A | Provided only for backwards compatibility, this option allows you to convert a tagger trained using a previous version of the tagger to the new single-file format. The value of this flag should be the path for the new model file, 'model' should be the path prefix to the old tagger (up to but not including the ".holder"), and you should supply the properties configuration for the old tagger with -props (before these two arguments). |
genprops | boolean | N/A | N/A | Use this option to output a default properties file, containing information about each of the possible configuration options. |
tagSeparator | char | / | All | Separator character that separates word and part of speech tags, such as out/IN or out_IN. For training and testing, this is the separator used in the train/test files. For tagging, this is the character that will be inserted between words and tags in the output. |
encoding | String | UTF-8 | All | Encoding of the read files (training, testing) and the output text files. |
tokenize | boolean | true | Tag,Test | Whether or not the file needs to be tokenized. If this is false, the tagger assumes that white space separates words if and only if they should be tagged as separate tokens, and that the input is strictly one sentence per line. |
tokenizerFactory | String | edu.stanford.nlp. process.PTBTokenizer | Tag,Test | Fully qualified class name of the tokenizer to use. edu.stanford.nlp.process.PTBTokenizer does basic English tokenization. |
tokenizerOptions | String | Tag,Test | Known options for the particular tokenizer used. A comma-separated list. For PTBTokenizer, options of interest include americanize=false and asciiQuotes (for German). Note that any choice of tokenizer options that conflicts with the tokenization used in the tagger training data will likely degrade tagger performance. | |
arch | String | generic | Train | Architecture of the model, as a comma-separated list of options, some with a parenthesized integer argument written k here: this determines what features are used to build your model. See ExtractorFrames and ExtractorFramesRare for more information. |
wordFunction | String | (none) | Train | A function to apply to the text before training or testing. Must inherit from edu.stanford.nlp.util.Function<String, String>. Can be blank. |
lang | String | english | Train | Language from which the part of speech tags are drawn. This option determines which tags are considered closed-class (only fixed set of words can be tagged with a closed-class tag, such as prepositions). Defined languages are 'english' (Penn tagset), 'polish' (very rudimentary), 'chinese', 'arabic', 'german', and 'medline'. |
openClassTags | String | N/A | Train | Space separated list of tags that should be considered open-class. All tags encountered that are not in this list are considered closed-class. E.g. format: "NN VB" |
closedClassTags | String | N/A | Train | Space separated list of tags that should be considered closed-class. All tags encountered that are not in this list are considered open-class. |
learnClosedClassTags | boolean | false | Train | If true, induce which tags are closed-class by counting as closed-class tags all those tags which have fewer unique word tokens than closedClassTagThreshold. |
closedClassTagThreshold | int | int | Train | Number of unique word tokens that a tag may have and still be considered closed-class; relevant only if learnClosedClassTags is true. |
sgml | boolean | false | Tag, Test | Very basic tagging of the contents of all sgml fields; for more complex mark-up, consider using the xmlInput option. |
xmlInput | String | Tag, Test | Give a space separated list of tags in an XML file whose content you would like tagged. Any internal tags that appear in the content of fields you would like tagged will be discarded; the rest of the XML will be preserved and the original text of specified fields will be replaced with the tagged text. | |
outputFile | String | "" | Tag | Path to write output to. If blank, stdout is used. |
outputFormat | String | "" | Tag | Output format. One of: slashTags (default), xml, or tsv |
outputFormatOptions | String | "" | Tag | Output format options. |
tagInside | String | "" | Tag | Tags inside elements that match the regular expression given in the String. |
search | String | cg | Train | Specify the search method to be used in the optimization method for training. Options are 'cg' (conjugate gradient) or 'iis' (improved iterative scaling). |
sigmaSquared | double | 0.5 | Train | Sigma-squared smoothing/regularization parameter to be used for conjugate gradient search. Default usually works reasonably well. |
iterations | int | 100 | Train | Number of iterations to be used for improved iterative scaling. |
rareWordThresh | int | 5 | Train | Words that appear fewer than this number of times during training are considered rare words and use extra rare word features. |
minFeatureThreshold | int | 5 | Train | Features whose history appears fewer than this number of times are discarded. |
curWordMinFeatureThreshold | int | 2 | Train | Words that occur more than this number of times will generate features with all of the tags they've been seen with. |
rareWordMinFeatureThresh | int | 10 | Train | Features of rare words whose histories occur fewer than this number of times are discarded. |
veryCommonWordThresh | int | 250 | Train | Words that occur more than this number of times form an equivalence class by themselves. Ignored unless you are using ambiguity classes. |
debug | boolean | boolean | All | Whether to write debugging information (words, top words, unknown words). Useful for error analysis. |
debugPrefix | String | N/A | All | File (path) prefix for where to write out the debugging information (relevant only if debug=true). |
Field Summary | |
---|---|
static String |
BASE_TAGGER_HOME
The directory from which to get taggers when using DEFAULT_NLP_GROUP_MODEL_PATH. |
static String |
DEFAULT_DISTRIBUTION_PATH
|
static String |
DEFAULT_NLP_GROUP_MODEL_PATH
|
static String |
TAGGER_HOME
|
Constructor Summary | |
---|---|
MaxentTagger()
|
|
MaxentTagger(String modelFile)
Constructor for a tagger using a model stored in a particular file. |
|
MaxentTagger(String modelFile,
TaggerConfig config)
Constructor for a tagger using a model stored in a particular file, with options taken from the supplied TaggerConfig. |
|
MaxentTagger(String modelFile,
TaggerConfig config,
boolean printLoading)
Initializer that loads the tagger. |
Method Summary | |
---|---|
ArrayList<TaggedWord> |
apply(List<? extends HasWord> in)
Expects a sentence and returns a tagged sentence. |
protected TokenizerFactory<? extends HasWord> |
chooseTokenizerFactory()
Figures out what tokenizer factory might be described by the config. |
protected static TokenizerFactory<? extends HasWord> |
chooseTokenizerFactory(boolean tokenize,
String tokenizerFactory,
String tokenizerOptions,
boolean invertible)
|
protected void |
dumpModel(PrintStream out)
|
TTags |
getTags()
|
static void |
lemmatize(List<CoreLabel> sentence,
Morphology morpha)
Adds lemmas to the given list of CoreLabels, using the given Morphology object. |
static void |
main(String[] args)
Command-line tagger interface. |
List<ArrayList<TaggedWord>> |
process(List<? extends List<? extends HasWord>> sentences)
Tags the Words in each Sentence in the given List with their grammatical part-of-speech. |
protected void |
readModelAndInit(TaggerConfig config,
DataInputStream rf,
boolean printLoading)
This reads the complete tagger from a single model file, and inits the tagger using a combination of the properties passed in and parameters from the file. |
protected void |
readModelAndInit(TaggerConfig config,
String modelFileOrUrl,
boolean printLoading)
This reads the complete tagger from a single model stored in a file, at a URL, or as a resource in a jar file, and inits the tagger using a combination of the properties passed in and parameters from the file. |
void |
runTagger(BufferedReader reader,
BufferedWriter writer,
String tagInside,
boolean stdin)
This method runs the tagger on the provided reader and writer. |
protected void |
saveModel(String filename,
TaggerConfig config)
|
void |
tagCoreLabels(List<CoreLabel> sentence)
Takes a sentence composed of CoreLabels and add the tags to the CoreLabels, modifying the input sentence. |
void |
tagFromXML(InputStream input,
Writer writer,
String... xmlTags)
Uses an XML transformer to turn an input stream into a bunch of output. |
void |
tagFromXML(Reader input,
Writer writer,
String... xmlTags)
|
ArrayList<TaggedWord> |
tagSentence(List<? extends HasWord> sentence)
Returns a new Sentence that is a copy of the given sentence with all the words tagged with their part-of-speech. |
String |
tagString(String toTag)
Tags the input string and returns the tagged version. |
String |
tagTokenizedString(String toTag)
Tags the tokenized input string and returns the tagged version. |
static List<List<HasWord>> |
tokenizeText(Reader r)
Reads data from r, tokenizes it with the default (Penn Treebank) tokenizer, and returns a List of Sentence objects, which can then be fed into tagSentence. |
protected static List<List<HasWord>> |
tokenizeText(Reader r,
TokenizerFactory<? extends HasWord> tokenizerFactory)
Reads data from r, tokenizes it with the given tokenizer, and returns a List of Lists of (extends) HasWord objects, which can then be fed into tagSentence. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String BASE_TAGGER_HOME
public static final String TAGGER_HOME
public static final String DEFAULT_NLP_GROUP_MODEL_PATH
public static final String DEFAULT_DISTRIBUTION_PATH
Constructor Detail |
---|
public MaxentTagger()
public MaxentTagger(String modelFile) throws IOException, ClassNotFoundException
modelFile
is a filename for the model data.
The tagger data is loaded when the
constructor is called (this can be slow).
This constructor first constructs a TaggerConfig object, which loads
the tagger options from the modelFile.
modelFile
- filename of the trained model
IOException
- if IO problem
ClassNotFoundException
- when there are errors loading a taggerpublic MaxentTagger(String modelFile, TaggerConfig config) throws IOException, ClassNotFoundException
modelFile
is a filename for the model data.
The tagger data is loaded when the
constructor is called (this can be slow).
This version assumes that the tagger options in the modelFile have
already been loaded into the TaggerConfig (if that is desired).
modelFile
- filename of the trained modelconfig
- The configuration for the tagger
IOException
- if IO problem
ClassNotFoundException
- when there are errors loading a taggerpublic MaxentTagger(String modelFile, TaggerConfig config, boolean printLoading) throws IOException, ClassNotFoundException
modelFile
- Where to initialize the tagger from.
Most commonly, this is the filename of the trained model,
for example,
/u/nlp/data/pos-tagger/wsj3t0-18-left3words/left3words-wsj-0-18.tagger
. However, if it starts with "https?://" it will
be interpreted as a URL. One can also load models
directly from the classpath, as in loading from
edu/stanford/nlp/models/pos-tagger/wsj3t0-18-bidirectional/bidirectional-distsim-wsj-0-18.taggerconfig
- TaggerConfig based on command-line argumentsprintLoading
- Whether to print a message saying what model file is being loaded and how long it took when finished.
IOException
- if IO problem
ClassNotFoundException
- when there are errors loading a taggerMethod Detail |
---|
protected TokenizerFactory<? extends HasWord> chooseTokenizerFactory() throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException
ClassNotFoundException
NoSuchMethodException
IllegalAccessException
InvocationTargetException
protected static TokenizerFactory<? extends HasWord> chooseTokenizerFactory(boolean tokenize, String tokenizerFactory, String tokenizerOptions, boolean invertible) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException
ClassNotFoundException
NoSuchMethodException
IllegalAccessException
InvocationTargetException
protected void saveModel(String filename, TaggerConfig config)
protected void readModelAndInit(TaggerConfig config, String modelFileOrUrl, boolean printLoading) throws IOException, ClassNotFoundException
Note for the future: This assumes that the TaggerConfig in the file has already been read and used. This work is done inside the constructor of TaggerConfig. It might be better to refactor things so that is all done inside this method, but for the moment it seemed better to leave working code alone [cdm 2008].
config
- The tagger configmodelFileOrUrl
- The name of the model file. This routine opens and closes it.printLoading
- Whether to print a message saying what model file is being loaded and how long it took when finished.
IOException
- If I/O errors, etc.
ClassNotFoundException
- especially for incompatible tagger formatsprotected void readModelAndInit(TaggerConfig config, DataInputStream rf, boolean printLoading) throws IOException, ClassNotFoundException
Note for the future: This assumes that the TaggerConfig in the file has already been read and used. It might be better to refactor things so that is all done inside this method, but for the moment it seemed better to leave working code alone [cdm 2008].
config
- The tagger configrf
- DataInputStream to read from. It's the caller's job to open and close this stream.printLoading
- Whether to print a message saying what model file is being loaded and how long it took when finished.
IOException
- If I/O errors
ClassNotFoundException
- If serialization errorsprotected void dumpModel(PrintStream out)
public TTags getTags()
public String tagTokenizedString(String toTag)
toTag
- The untagged input String
public String tagString(String toTag)
toTag
- The untagged input String
public ArrayList<TaggedWord> apply(List<? extends HasWord> in)
apply
in interface Function<List<? extends HasWord>,ArrayList<TaggedWord>>
in
- This needs to be a Sentence
public List<ArrayList<TaggedWord>> process(List<? extends List<? extends HasWord>> sentences)
NOTE: The input document must contain sentences as its elements,
not words. To turn a Document of words into a Document of sentences, run
it through WordToSentenceProcessor
.
process
in interface ListProcessor<List<? extends HasWord>,ArrayList<TaggedWord>>
sentences
- A List of Sentence
public ArrayList<TaggedWord> tagSentence(List<? extends HasWord> sentence)
sentence
- sentence to tag
public void tagCoreLabels(List<CoreLabel> sentence)
public static void lemmatize(List<CoreLabel> sentence, Morphology morpha)
public static List<List<HasWord>> tokenizeText(Reader r)
r
- Reader where untokenized text is read
protected static List<List<HasWord>> tokenizeText(Reader r, TokenizerFactory<? extends HasWord> tokenizerFactory)
r
- Reader where untokenized text is readtokenizerFactory
- Tokenizer. This can be null
in which case
the default English tokenizer (PTBTokenizerFactory) is used.
public void tagFromXML(InputStream input, Writer writer, String... xmlTags)
public void tagFromXML(Reader input, Writer writer, String... xmlTags)
public void runTagger(BufferedReader reader, BufferedWriter writer, String tagInside, boolean stdin) throws IOException, ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException
reader
, applies the
tagger to it one sentence at a time (determined using
documentPreprocessor), and writes the output to the given
writer
.
The document is broken into sentences using the sentence
processor determined in the tagger's TaggerConfig.
tagInside
makes the tagger run in XML mode... if set
to non-empty, instead of processing the document as one large
text blob, it considers each region in between the given tag to
be a separate text blob.
stdin
makes the tagger take lines one at a time from
the reader and print out a bit more nice formatting to the
writer. It doesn't actually require the reader to be stdin,
though. This is mutually exclusive with tagInside; if tagInside
is not empty, stdin will be ignored.
IOException
ClassNotFoundException
NoSuchMethodException
IllegalAccessException
InvocationTargetException
public static void main(String[] args) throws Exception
args
- Command-line arguments
IOException
- If any file problems
Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |