org.openimaj.ml.annotation.bayes

Class NaiveBayesAnnotator<OBJECT,ANNOTATION>

java.lang.Object

org.openimaj.ml.annotation.AbstractAnnotator<OBJECT,ANNOTATION>

org.openimaj.ml.annotation.IncrementalAnnotator<OBJECT,ANNOTATION>

org.openimaj.ml.annotation.bayes.NaiveBayesAnnotator<OBJECT,ANNOTATION>

Type Parameters:

OBJECT - Type of object being annotated

ANNOTATION - Type of annotation

All Implemented Interfaces:

Classifier<ANNOTATION,OBJECT>, Annotator<OBJECT,ANNOTATION>, IncrementalTrainer<Annotated<OBJECT,ANNOTATION>>

Direct Known Subclasses:

NaiveBayesSentimentAnnotator

public class NaiveBayesAnnotator<OBJECT,ANNOTATION>
extends IncrementalAnnotator<OBJECT,ANNOTATION>

Annotator based on a Naive Bayes Classifier. Uses a VectorNaiveBayesCategorizer as the actual classifier.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NaiveBayesAnnotator.Mode Modes of operation for prediction using the NaiveBayesAnnotator.

Constructor Summary

Constructors

Constructor and Description
NaiveBayesAnnotator(FeatureExtractor<? extends FeatureVector,OBJECT> extractor, NaiveBayesAnnotator.Mode mode) Construct a NaiveBayesAnnotator with the given feature extractor and mode of operation.

Method Summary

Modifier and Type	Method and Description
List<ScoredAnnotation<ANNOTATION>>	annotate(OBJECT object) Generate annotations for the given object.
static <OBJECT extends FeatureVector,ANNOTATION> NaiveBayesAnnotator<OBJECT,ANNOTATION>	create(NaiveBayesAnnotator.Mode mode) Convenience method to construct a NaiveBayesAnnotator in the case where the raw objects are themselves the feature and thus an IdentityFeatureExtractor can be used.
Set<ANNOTATION>	getAnnotations()
void	reset() Reset the object to its initial condition, as if it hasn't seen any training data.
void	train(Annotated<OBJECT,ANNOTATION> annotated) Train/update object using a new instance.

Methods inherited from class org.openimaj.ml.annotation.IncrementalAnnotator

train, train, trainMultiClass

Methods inherited from class org.openimaj.ml.annotation.AbstractAnnotator

classify

Methods inherited from class java.lang.Object

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

Constructor Detail

NaiveBayesAnnotator

public NaiveBayesAnnotator(FeatureExtractor<? extends FeatureVector,OBJECT> extractor,
                           NaiveBayesAnnotator.Mode mode)

Construct a NaiveBayesAnnotator with the given feature extractor and mode of operation.

Parameters:

extractor - the feature extractor.

mode - the mode of operation during prediction

Method Detail

create

public static <OBJECT extends FeatureVector,ANNOTATION> NaiveBayesAnnotator<OBJECT,ANNOTATION> create(NaiveBayesAnnotator.Mode mode)

Convenience method to construct a NaiveBayesAnnotator in the case where the raw objects are themselves the feature and thus an IdentityFeatureExtractor can be used. This method is equivalent to calling new NaiveBayesAnnotator(new IdentityFeatureExtractor