edu.cmu.minorthird.text.learn
Interface MixupCompatible

All Known Implementing Classes:
ConditionalSemiMarkovModel.CSMMSpanFE, ConditionalSemiMarkovModel.CSMMWithDictionarySpanFE, FeatureBuffer, Recommended.DocumentFE, Recommended.HMMTokenFE, Recommended.MultitokenSpanFE, Recommended.TokenFE, Recommended.TokenPropUsingFE, SampleFE.AnnotatedSpanFE, SampleFE.BagOfLowerCaseWordsFE, SampleFE.BagOfWordsFE, SampleFE.ExtractionFE, SpanFE

public interface MixupCompatible

Marker interface for SpanFeatureExtractor objects which allow one to attach a type of required annotations that must be present before feature extraction starts. This also allows one to attach to a feature extractor an AnnotatorLoader, which helps find Annotators to provide the required annotations.

Author:
William Cohen

Method Summary
 java.lang.String getRequiredAnnotation()
          Retrieve the annotation required by this SpanFeatureExtractor.
 void setAnnotatorLoader(AnnotatorLoader loader)
          Attach an annotatorLoader to the SpanFeatureExtractor, which is used to find the required Annotation (and any other Annotations that that it might recursively require.)
 void setRequiredAnnotation(java.lang.String annotation)
          A correct implementation of a MixupCompatible SpanFeatureExtractor will call textLabels.require(annotation,null,loader) before extracting features relative to textLabels.
 

Method Detail

setRequiredAnnotation

void setRequiredAnnotation(java.lang.String annotation)
A correct implementation of a MixupCompatible SpanFeatureExtractor will call textLabels.require(annotation,null,loader) before extracting features relative to textLabels. A null annotation means that no textLabels.require(...) call will be made.


getRequiredAnnotation

java.lang.String getRequiredAnnotation()
Retrieve the annotation required by this SpanFeatureExtractor.


setAnnotatorLoader

void setAnnotatorLoader(AnnotatorLoader loader)
Attach an annotatorLoader to the SpanFeatureExtractor, which is used to find the required Annotation (and any other Annotations that that it might recursively require.)