edu.stanford.nlp.ie.machinereading

Class BasicRelationExtractor

java.lang.Object

edu.stanford.nlp.ie.machinereading.BasicRelationExtractor

All Implemented Interfaces:

Extractor, java.io.Serializable

public class BasicRelationExtractor
extends java.lang.Object
implements Extractor

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LinearClassifier<java.lang.String,java.lang.String>	classifier
protected boolean	createUnrelatedRelations If true, it creates automatically negative examples by generating all combinations between EntityMentions in a sentence This is the common behavior, but for some domain (i.e., KBP) it must disabled.
int	featureCountThreshold
RelationFeatureFactory	featureFactory
java.lang.String	relationExtractorClassifierType which classifier to use (can be 'linear' or 'svm')
protected RelationMentionFactory	relationMentionFactory
double	sigma strength of the prior on the linear classifier (passed to LinearClassifierFactory) or the C constant if relationExtractorClassifierType=svm

Constructor Summary

Constructors

Constructor and Description
BasicRelationExtractor(RelationFeatureFactory featureFac, java.lang.Boolean createUnrelatedRelations, RelationMentionFactory factory)

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation dataset) Annotates the given dataset with the current model This works in place, i.e., it adds ExtractionObject objects to the sentences in the dataset To make sure you are not messing with gold annotation create a copy of the ExtractionDataSet first!
java.util.List<java.lang.String>	annotateMulticlass(java.util.List<Datum<java.lang.String,java.lang.String>> testDatums)
void	annotateSentence(CoreMap sentence)
protected java.lang.String	classOf(Datum<java.lang.String,java.lang.String> datum, ExtractionObject rel)
protected GeneralDataset<java.lang.String,java.lang.String>	createDataset(Annotation corpus)
protected Datum<java.lang.String,java.lang.String>	createDatum(RelationMention rel)
protected Datum<java.lang.String,java.lang.String>	createDatum(RelationMention rel, java.lang.String label)
protected java.util.List<RelationMention>	extractAllRelations(CoreMap sentence) Predict a relation for each pair of entities in the sentence; including relations of type unrelated.
protected void	justificationOf(Datum<java.lang.String,java.lang.String> testDatum, java.io.PrintWriter pw, java.lang.String label)
static BasicRelationExtractor	load(java.lang.String modelPath)
protected Counter<java.lang.String>	probabilityOf(Datum<java.lang.String,java.lang.String> testDatum)
protected static void	reportWeights(LinearClassifier<java.lang.String,java.lang.String> classifier, java.lang.String classLabel)
void	save(java.lang.String modelpath) Serializes this extractor to a file
void	setCreateUnrelatedRelations(boolean b)
void	setFeatureCountThreshold(int i)
void	setLoggerLevel(java.util.logging.Level level)
void	setRelationExtractorClassifierType(java.lang.String s)
void	setSigma(double d)
void	setValidator(LabelValidator lv)
void	train(Annotation sentences) Train on a list of ExtractionSentence containing labeled RelationMention objects
void	trainMulticlass(GeneralDataset<java.lang.String,java.lang.String> trainSet)

Methods inherited from class java.lang.Object

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

Field Detail

classifier

protected LinearClassifier<java.lang.String,java.lang.String> classifier

featureCountThreshold

@ArgumentParser.Option(name="featureCountThreshold",
                       gloss="feature count threshold to apply to dataset")
public int featureCountThreshold

featureFactory

@ArgumentParser.Option(name="featureFactory",
                       gloss="Feature factory for the relation extractor")
public RelationFeatureFactory featureFactory

sigma

@ArgumentParser.Option(name="sigma",
                       gloss="strength of the prior on the linear classifier (passed to LinearClassifierFactory) or the C constant if relationExtractorClassifierType=svm")
public double sigma

strength of the prior on the linear classifier (passed to LinearClassifierFactory) or the C constant if relationExtractorClassifierType=svm

relationExtractorClassifierType

public java.lang.String relationExtractorClassifierType

which classifier to use (can be 'linear' or 'svm')

createUnrelatedRelations

protected boolean createUnrelatedRelations

If true, it creates automatically negative examples by generating all combinations between EntityMentions in a sentence This is the common behavior, but for some domain (i.e., KBP) it must disabled. In these domains, the negative relation examples are created in the reader

relationMentionFactory

protected RelationMentionFactory relationMentionFactory

Constructor Detail

BasicRelationExtractor

public BasicRelationExtractor(RelationFeatureFactory featureFac,
                              java.lang.Boolean createUnrelatedRelations,
                              RelationMentionFactory factory)

Method Detail

setValidator

public void setValidator(LabelValidator lv)

setRelationExtractorClassifierType

public void setRelationExtractorClassifierType(java.lang.String s)

setFeatureCountThreshold

public void setFeatureCountThreshold(int i)

setSigma

public void setSigma(double d)

setCreateUnrelatedRelations

public void setCreateUnrelatedRelations(boolean b)

load

public static BasicRelationExtractor load(java.lang.String modelPath)
                                   throws java.io.IOException,
                                          java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

save

public void save(java.lang.String modelpath)
          throws java.io.IOException

Description copied from interface: Extractor

Serializes this extractor to a file

Specified by:

save in interface Extractor

Parameters:

modelpath - where to save the extractor

Throws:

java.io.IOException

train

public void train(Annotation sentences)

Train on a list of ExtractionSentence containing labeled RelationMention objects

Specified by:

train in interface Extractor

Parameters:

sentences - dataset to train from (this should already have annotations and will typically be created by a reader)

trainMulticlass

public void trainMulticlass(GeneralDataset<java.lang.String,java.lang.String> trainSet)

reportWeights

protected static void reportWeights(LinearClassifier<java.lang.String,java.lang.String> classifier,
                                    java.lang.String classLabel)

classOf

protected java.lang.String classOf(Datum<java.lang.String,java.lang.String> datum,
                                   ExtractionObject rel)

probabilityOf

protected Counter<java.lang.String> probabilityOf(Datum<java.lang.String,java.lang.String> testDatum)

justificationOf

protected void justificationOf(Datum<java.lang.String,java.lang.String> testDatum,
                               java.io.PrintWriter pw,
                               java.lang.String label)

extractAllRelations

protected java.util.List<RelationMention> extractAllRelations(CoreMap sentence)

Predict a relation for each pair of entities in the sentence; including relations of type unrelated. This creates new RelationMention objects!

annotateMulticlass

public java.util.List<java.lang.String> annotateMulticlass(java.util.List<Datum<java.lang.String,java.lang.String>> testDatums)

annotateSentence

public void annotateSentence(CoreMap sentence)

annotate

public void annotate(Annotation dataset)

Description copied from interface: Extractor

Annotates the given dataset with the current model This works in place, i.e., it adds ExtractionObject objects to the sentences in the dataset To make sure you are not messing with gold annotation create a copy of the ExtractionDataSet first!

Specified by:

annotate in interface Extractor

Parameters:

dataset - dataset to annotate

createDataset

protected GeneralDataset<java.lang.String,java.lang.String> createDataset(Annotation corpus)

createDatum

protected Datum<java.lang.String,java.lang.String> createDatum(RelationMention rel)

createDatum

protected Datum<java.lang.String,java.lang.String> createDatum(RelationMention rel,
                                                               java.lang.String label)

setLoggerLevel

public void setLoggerLevel(java.util.logging.Level level)

Specified by:

setLoggerLevel in interface Extractor