edu.stanford.nlp.ie

Class ClassifierCombiner<IN extends CoreMap & HasWord>

java.lang.Object

edu.stanford.nlp.ie.AbstractSequenceClassifier<IN>

edu.stanford.nlp.ie.ClassifierCombiner<IN>

All Implemented Interfaces:

java.util.function.Function<java.lang.String,java.lang.String>

Direct Known Subclasses:

NERClassifierCombiner

public class ClassifierCombiner<IN extends CoreMap & HasWord>
extends AbstractSequenceClassifier<IN>

Merges the outputs of two or more AbstractSequenceClassifiers according to a simple precedence scheme: any given base classifier contributes only classifications of labels that do not exist in the base classifiers specified before, and that do not have any token overlap with labels assigned by higher priority classifiers.

This is a pure AbstractSequenceClassifier, i.e., it sets the AnswerAnnotation label. If you work with NER classifiers, you should use NERClassifierCombiner. This class inherits from ClassifierCombiner, and takes care that all AnswerAnnotations are also copied to NERAnnotation.

You can specify up to 10 base classifiers using the -loadClassifier1 to -loadClassifier10 properties. We also maintain the older usage when only two base classifiers were accepted, specified using -loadClassifier and -loadAuxClassifier.

ms 2009: removed all NER functionality (see NERClassifierCombiner), changed code so it accepts an arbitrary number of base classifiers, removed dead code.

Author:

Chris Cox, Mihai Surdeanu

Field Summary

Fields inherited from class edu.stanford.nlp.ie.AbstractSequenceClassifier

classIndex, featureFactories, flags, knownLCWords, pad, windowSize

Constructor Summary

Constructors

Constructor and Description
ClassifierCombiner(AbstractSequenceClassifier<IN>... classifiers) Combines a series of base classifiers.
ClassifierCombiner(edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode combinationMode, java.lang.String... loadPaths) Loads a series of base classifiers from the paths specified using the Properties specified.
ClassifierCombiner(java.io.ObjectInputStream ois, java.util.Properties props)
ClassifierCombiner(java.util.Properties p)
ClassifierCombiner(java.util.Properties props, edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode combinationMode, java.lang.String... loadPaths) Loads a series of base classifiers from the paths specified using the Properties specified.
ClassifierCombiner(java.lang.String... loadPaths) Loads a series of base classifiers from the paths specified.

Method Summary

Modifier and Type	Method and Description
java.util.List<IN>	classify(java.util.List<IN> tokens) Generates the AnswerAnnotation labels of the combined model for the given tokens, storing them in place in the tokens.
java.util.List<IN>	classifyWithGlobalInformation(java.util.List<IN> tokenSeq, CoreMap doc, CoreMap sent) Classify a List of something that extends CoreMap using as additional information whatever is stored in the document and sentence.
static void	examineCRF(ClassifierCombiner cc, java.lang.String crfNameOrIndex, SeqClassifierFlags flags, java.lang.String testFile, java.lang.String testFiles, DocumentReaderAndWriter<CoreLabel> readerAndWriter)
static edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode	extractCombinationMode(java.util.Properties p) Either finds COMBINATION_MODE_PROPERTY or returns a default value.
static edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode	extractCombinationModeSafe(java.util.Properties p) Either finds COMBINATION_MODE_PROPERTY or returns a default value.
static ClassifierCombiner	getClassifier(java.io.ObjectInputStream ois, java.util.Properties props)
static ClassifierCombiner	getClassifier(java.lang.String loadPath, java.util.Properties props)
java.util.Set<java.lang.String>	labels()
void	loadClassifier(java.io.ObjectInputStream in, java.util.Properties props) Load a classifier from the specified input stream.
static <INN extends CoreMap & HasWord> AbstractSequenceClassifier<INN>	loadClassifierFromPath(java.util.Properties props, java.lang.String path)
static void	main(java.lang.String[] args) Some basic testing of the ClassifierCombiner.
void	serializeClassifier(java.io.ObjectOutputStream oos) Serialize a sequence classifier to an object output stream
void	serializeClassifier(java.lang.String serializePath) Serialize a sequence classifier to a file on the given path.
static void	showCCInfo(ClassifierCombiner cc)
void	train(java.util.Collection<java.util.List<IN>> docs, DocumentReaderAndWriter<IN> readerAndWriter) Trains a classifier from a Collection of sequences.

Methods inherited from class edu.stanford.nlp.ie.AbstractSequenceClassifier

apply, backgroundSymbol, classify, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswersKBest, classifyAndWriteAnswersKBest, classifyAndWriteViterbiSearchGraph, classifyFile, classifyFilesAndWriteAnswers, classifyFilesAndWriteAnswers, classifyKBest, classifyRaw, classifySentence, classifySentenceWithGlobalInformation, classifyStdin, classifyStdin, classifyToCharacterOffsets, classifyToString, classifyToString, classifyWithInlineXML, countResults, countResultsSegmenter, defaultReaderAndWriter, dumpFeatures, finalizeClassification, getKnownLCWords, getSampler, getSequenceModel, loadClassifier, loadClassifier, loadClassifier, loadClassifier, loadClassifier, loadClassifier, loadClassifierNoExceptions, loadClassifierNoExceptions, loadClassifierNoExceptions, loadClassifierNoExceptions, loadClassifierNoExceptions, makeObjectBankFromFile, makeObjectBankFromFile, makeObjectBankFromFiles, makeObjectBankFromFiles, makeObjectBankFromFiles, makeObjectBankFromReader, makeObjectBankFromString, makePlainTextReaderAndWriter, makePlainTextReaderAndWriter, makeReaderAndWriter, plainTextReaderAndWriter, printFeatureLists, printFeatures, printProbs, printProbs, printProbsDocument, printProbsDocuments, printResults, reinit, segmentString, segmentString, train, train, train, train, train, train, windowSize, writeAnswers

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

ClassifierCombiner

public ClassifierCombiner(java.util.Properties p)
                   throws java.io.IOException

Parameters:

p - Properties File that specifies loadClassifier and loadAuxClassifier properties or, alternatively, loadClassifier[1-10] properties.

Throws:

java.io.FileNotFoundException - If classifier files not found

java.io.IOException

ClassifierCombiner

public ClassifierCombiner(java.util.Properties props,
                          edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode combinationMode,
                          java.lang.String... loadPaths)
                   throws java.io.IOException

Loads a series of base classifiers from the paths specified using the Properties specified.

Parameters:

props - Properties for the classifier to use (encodings, output format, etc.)

combinationMode - How to handle multiple classifiers specifying the same entity type

loadPaths - Paths to the base classifiers

Throws:

java.io.IOException - If IO errors in loading classifier files

ClassifierCombiner

public ClassifierCombiner(edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode combinationMode,
                          java.lang.String... loadPaths)
                   throws java.io.IOException

Loads a series of base classifiers from the paths specified using the Properties specified.

Parameters:

combinationMode - How to handle multiple classifiers specifying the same entity type

loadPaths - Paths to the base classifiers

Throws:

java.io.IOException - If IO errors in loading classifier files

ClassifierCombiner

public ClassifierCombiner(java.lang.String... loadPaths)
                   throws java.io.IOException

Loads a series of base classifiers from the paths specified.

Parameters:

loadPaths - Paths to the base classifiers

Throws:

java.io.FileNotFoundException - If classifier files not found

java.io.IOException

ClassifierCombiner

@SafeVarargs
public ClassifierCombiner(AbstractSequenceClassifier<IN>... classifiers)

Combines a series of base classifiers.

Parameters:

classifiers - The base classifiers

ClassifierCombiner

public ClassifierCombiner(java.io.ObjectInputStream ois,
                          java.util.Properties props)
                   throws java.io.IOException,
                          java.lang.ClassNotFoundException,
                          java.lang.ClassCastException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.ClassCastException

Method Detail

extractCombinationMode

public static edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode extractCombinationMode(java.util.Properties p)

Either finds COMBINATION_MODE_PROPERTY or returns a default value.

extractCombinationModeSafe

public static edu.stanford.nlp.ie.ClassifierCombiner.CombinationMode extractCombinationModeSafe(java.util.Properties p)

Either finds COMBINATION_MODE_PROPERTY or returns a default value. If the value is not a legal value, a warning is printed.

loadClassifierFromPath

public static <INN extends CoreMap & HasWord> AbstractSequenceClassifier<INN> loadClassifierFromPath(java.util.Properties props,
                                                                                                     java.lang.String path)
                                                                                              throws java.io.IOException

Throws:

java.io.IOException

labels

public java.util.Set<java.lang.String> labels()

Overrides:

labels in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

classify

public java.util.List<IN> classify(java.util.List<IN> tokens)

Generates the AnswerAnnotation labels of the combined model for the given tokens, storing them in place in the tokens.

Specified by:

classify in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

Parameters:

tokens - A List of IN

Returns:

The passed in parameters, which will have the AnswerAnnotation field added/overwritten

train

public void train(java.util.Collection<java.util.List<IN>> docs,
                  DocumentReaderAndWriter<IN> readerAndWriter)

Description copied from class: AbstractSequenceClassifier

Trains a classifier from a Collection of sequences. Note that the Collection can be (and usually is) an ObjectBank.

Specified by:

train in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

Parameters:

docs - An ObjectBank or a collection of sequences of IN

readerAndWriter - A DocumentReaderAndWriter to use when loading test files

serializeClassifier

public void serializeClassifier(java.lang.String serializePath)

Description copied from class: AbstractSequenceClassifier

Serialize a sequence classifier to a file on the given path.

Specified by:

serializeClassifier in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

Parameters:

serializePath - The path/filename to write the classifier to.

serializeClassifier

public void serializeClassifier(java.io.ObjectOutputStream oos)

Description copied from class: AbstractSequenceClassifier

Serialize a sequence classifier to an object output stream

Specified by:

serializeClassifier in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

loadClassifier

public void loadClassifier(java.io.ObjectInputStream in,
                           java.util.Properties props)
                    throws java.io.IOException,
                           java.lang.ClassCastException,
                           java.lang.ClassNotFoundException

Description copied from class: AbstractSequenceClassifier

Load a classifier from the specified input stream. The classifier is reinitialized from the flags serialized in the classifier.

Specified by:

loadClassifier in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

Parameters:

in - The InputStream to load the serialized classifier from

props - This Properties object will be used to update the SeqClassifierFlags which are read from the serialized classifier

Throws:

java.io.IOException - If there are problems accessing the input stream

java.lang.ClassCastException - If there are problems interpreting the serialized data

java.lang.ClassNotFoundException - If there are problems interpreting the serialized data

classifyWithGlobalInformation

public java.util.List<IN> classifyWithGlobalInformation(java.util.List<IN> tokenSeq,
                                                        CoreMap doc,
                                                        CoreMap sent)

Description copied from class: AbstractSequenceClassifier

Classify a List of something that extends CoreMap using as additional information whatever is stored in the document and sentence. This is needed for SUTime (NumberSequenceClassifier), which requires the document date to resolve relative dates.

Specified by:

classifyWithGlobalInformation in class AbstractSequenceClassifier<IN extends CoreMap & HasWord>

Parameters:

tokenSeq - A List of something that extends CoreMap

Returns:

Classified version of the input tokenSequence

getClassifier

public static ClassifierCombiner getClassifier(java.lang.String loadPath,
                                               java.util.Properties props)
                                        throws java.io.IOException,
                                               java.lang.ClassNotFoundException,
                                               java.lang.ClassCastException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.ClassCastException

getClassifier

public static ClassifierCombiner getClassifier(java.io.ObjectInputStream ois,
                                               java.util.Properties props)
                                        throws java.io.IOException,
                                               java.lang.ClassCastException,
                                               java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassCastException

java.lang.ClassNotFoundException

examineCRF

public static void examineCRF(ClassifierCombiner cc,
                              java.lang.String crfNameOrIndex,
                              SeqClassifierFlags flags,
                              java.lang.String testFile,
                              java.lang.String testFiles,
                              DocumentReaderAndWriter<CoreLabel> readerAndWriter)
                       throws java.lang.Exception

Throws:

java.lang.Exception

showCCInfo

public static void showCCInfo(ClassifierCombiner cc)

main

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

Some basic testing of the ClassifierCombiner.

Parameters:

args - Command-line arguments as properties: -loadClassifier1 serializedFile -loadClassifier2 serializedFile

Throws:

java.lang.Exception - If IO or serialization error loading classifiers