MachineReadingProperties.java

package edu.stanford.nlp.ie.machinereading;

import java.util.logging.Logger;

import edu.stanford.nlp.ie.machinereading.structure.RelationMentionFactory;
import edu.stanford.nlp.util.Execution.Option;

public class MachineReadingProperties {
  @Option(name="logger", gloss="Static logger for this entire class")
  public static Logger logger = Logger.getLogger(MachineReading.class.getName());
  
  /*
   * general options
   */

  @Option(name="datasetReaderClass", gloss="which GenericDataSetReader to use (needs to match the corpus in question)", required=true)
  static public Class<GenericDataSetReader> datasetReaderClass;
  

  @Option(name="datasetAuxReaderClass", gloss="which GenericDataSetReader to use for aux data set (needs to match the corpus in question)" )
  static public Class<GenericDataSetReader> datasetAuxReaderClass;
  
  @Option(name="useNewHeadFinder",gloss="If false, use the original head (and worse) finding mechanism in GenericDataSetReader.  This option is primarily around for legacy purposes.")
  static public boolean useNewHeadFinder = true;

  @Option(name="readerLogLevel",gloss="verbosity of the corpus reader")
  static public String readerLogLevel = "SEVERE";

  @Option(name="serializeCorpora",gloss="if false, we do not attempt to serialize the train/test corpora after reading")
  static public boolean serializeCorpora = true;
  
  @Option(name="forceGenerationOfIndexSpans",gloss="if true (default), regenerate span annotations for trees")
  static public boolean forceGenerationOfIndexSpans = true;

  /*
   * entity extraction options
   */
  
  
  @Option(name="serializedEntityExtractorPath",gloss="where to store/load the serialized entity extraction model")
  protected static String serializedEntityExtractorPath = "";
  
  @Option(name="serializedEntityExtractionResults",gloss="where to store the serialized sentences containing the results of entity extraction")
  protected static String serializedEntityExtractionResults;
  
  // TODO this option is temporary and should be removed when (if?) gazetteers get
  // folded into feature factories

  @Option(name="entityGazetteerPath",gloss="location of entity gazetteer file (if you're using one) -- this is a temporary option")
  static public String entityGazetteerPath;
  
  @Option(name="entityClassifier",gloss="entity extractor class to use")
  static public Class<BasicEntityExtractor> entityClassifier = edu.stanford.nlp.ie.machinereading.BasicEntityExtractor.class;
  
  @Option(name="entityResultsPrinters",gloss="comma-separated list of ResultsPrinter subclasses to use for printing the results of entity extraction")
  static public String entityResultsPrinters = "";
  
  /*
   * relation extraction options
   */

  @Option(name="serializedRelationExtractorPath",gloss="where to store/load the serialized relation extraction model")
  protected static String serializedRelationExtractorPath = null;
  
  @Option(name="serializedRelationExtractionResults",gloss="where to store the serialized sentences containing the results of relation extraction")
  protected static String serializedRelationExtractionResults = null;
  
  @Option(name="relationFeatureFactoryClass",gloss="FeatureFactory class to use for generating features from relations for relation extraction")
  static public Class<RelationFeatureFactory> relationFeatureFactoryClass = edu.stanford.nlp.ie.machinereading.RelationFeatureFactory.class;

  @Option(name="relationMentionFactoryClass",gloss="relation mention factory class to use.")
  static public Class<RelationMentionFactory> relationMentionFactoryClass =  edu.stanford.nlp.ie.machinereading.structure.RelationMentionFactory.class;

  @Option(name="relationFeatures",gloss="comma-separated list of feature types to generate for relation extraction.")
  static public String relationFeatures = "all";
  
  @Option(name="relationResultsPrinters",gloss="comma-separated list of ResultsPrinter subclasses to use for printing the results of relation extraction")
  static public String relationResultsPrinters = "edu.stanford.nlp.ie.machinereading.RelationExtractorResultsPrinter";
  
  @Option(name="trainRelationsUsingPredictedEntities",gloss="if true, the relation extraction model trains using predicted rather than gold entity mentions")
  static public boolean trainRelationsUsingPredictedEntities = false;
  
  @Option(name="testRelationsUsingPredictedEntities",gloss="if true, the relation extraction model is evaluated using predicted rather than gold entity mentions.")
  static public boolean testRelationsUsingPredictedEntities = false;

  @Option(name="createUnrelatedRelations",gloss="If true, it creates automatically negative examples by generating all combinations between EntityMentions in a sentence")
  static public boolean createUnrelatedRelations = true;
  
  @Option(name="doNotLexicalizeFirstArg",gloss="If true, it does not create any lexicalized features from the first argument (needed for KBP)")
  static public boolean doNotLexicalizeFirstArg = false;
  
  // TODO: temporary NFL deadline based hack. remove it.
  @Option(name="useRelationExtractionModelMerging",gloss="If true, the relation extractor will use ExtractorMerger for annotation (not training)")
  static public boolean useRelationExtractionModelMerging = false;

  @Option(name="relationsToSkipDuringTraining",gloss="comma-separated list relation types to skip during training")
  static public String relationsToSkipDuringTraining ="";
  
  @Option(name="relationExtractionPostProcessorClass",gloss="additional (probably domain-dependent) annotator to postprocess relations")
  static public Class<Extractor> relationExtractionPostProcessorClass;
  
  /*
   * event extraction options
   */
  
  @Option(name="serializedEventExtractorPath",gloss="where to store/load the serialized event extraction model")
  protected static String serializedEventExtractorPath = "";
  
  @Option(name="serializedEventExtractionResults",gloss="where to store the serialized sentences containing the results of event extraction")
  protected static String serializedEventExtractionResults;
  
  @Option(name="eventResultsPrinters",gloss="comma-separated list of ResultsPrinter subclasses to use for printing the results of event extraction")
  static public String eventResultsPrinters = "";

  @Option(name="trainEventsUsingPredictedEntities",gloss="if true, the event extraction model trains using predicted rather than gold entity mentions")
  static public boolean trainEventsUsingPredictedEntities = false;

  @Option(name="testEventsUsingPredictedEntities",gloss="if true, the event extraction model is evaluated using predicted rather than gold entity mentions")
  static public boolean testEventsUsingPredictedEntities = false;
  
  /*
   * global, domain-dependent options
   */

  @Option(name="consistencyCheck",gloss="consistency checker class to use")
  static public Class<Extractor> consistencyCheck;
  
  
  /*
   * training options
   */

  @Option(name="trainPath",gloss=" path to the training file/directory")
  static protected String trainPath;
  
  @Option(name="auxDataPath",gloss="path to the aux training file/directory")
  static protected String auxDataPath;

  @Option(name="serializedTrainingSentencesPath",gloss=" where to store the serialized training sentences objects", required = true)
  static protected String serializedTrainingSentencesPath;
  
  @Option(name="serializedAuxTrainingSentencesPath",gloss="where to store the serialized aux training sentences objects")
  static protected String serializedAuxTrainingSentencesPath;
    
  @Option(name="loadModel",gloss="if true, load a serialized model rather than training a new one")
  static protected boolean loadModel = false;

  /**
   * evaluation options (ignored if trainOnly is true)
   */
  

  @Option(name="trainOnly",gloss="if true, don't run evaluation (implies forceRetraining)")
  static protected boolean trainOnly = false;

  @Option(name="testPath",gloss="path to the testing file/directory")
  static protected String testPath;

  @Option(name="serializedTestSentencesPath",gloss="where to store the serialized test sentence objects")
  static protected String serializedTestSentencesPath;
 
  @Option(name="extractEntities",gloss="whether to extract entities, or use gold-standard entities for relation/event extraction")
  protected static boolean extractEntities = true;

  @Option(name="extractRelations",gloss="whether we should extract relations")
  protected static boolean extractRelations = true;
  
  @Option(name="extractEvents",gloss="whether we should extract events")
  protected static boolean extractEvents = true;
  
  
  /*
   * cross-validation options
   */
  @Option(name="crossValidate",gloss="if true, run cross-validation")
  protected static boolean crossValidate = false;

  @Option(name="kfold",gloss="number of partitions in training data for cross validation")
  static public int kfold = 5;

  @Option(name="percentageOfTrain",gloss="Pct of train partition to use for training (e.g. for RELMS experiment)")
  static public double percentageOfTrain = 1.0;

}