org.openimaj.ml.annotation

Class InstanceCachingIncrementalBatchAnnotator<OBJECT,ANNOTATION>

java.lang.Object

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

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

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

Type Parameters:

OBJECT - Type of object

ANNOTATION - Type of annotation

All Implemented Interfaces:

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

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

Adaptor that allows a BatchAnnotator to behave like a IncrementalAnnotator by caching instances and then performing training only when annotate(Object) is called.

Author:

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

Constructor Summary

Constructors

Constructor and Description
InstanceCachingIncrementalBatchAnnotator(BatchAnnotator<OBJECT,ANNOTATION> batchAnnotator) Construct with an in-memory cache and the given batch annotator.
InstanceCachingIncrementalBatchAnnotator(BatchAnnotator<OBJECT,ANNOTATION> batchAnnotator, GroupedListCache<ANNOTATION,OBJECT> cache) Construct with the given batch annotator and cache implementation.

Method Summary

Methods

Modifier and Type	Method and Description
List<ScoredAnnotation<ANNOTATION>>	annotate(OBJECT object) Generate annotations for the given object.
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

InstanceCachingIncrementalBatchAnnotator

public InstanceCachingIncrementalBatchAnnotator(BatchAnnotator<OBJECT,ANNOTATION> batchAnnotator)

Construct with an in-memory cache and the given batch annotator.

Parameters:

batchAnnotator - the batch annotator

InstanceCachingIncrementalBatchAnnotator

public InstanceCachingIncrementalBatchAnnotator(BatchAnnotator<OBJECT,ANNOTATION> batchAnnotator,
                                        GroupedListCache<ANNOTATION,OBJECT> cache)

Construct with the given batch annotator and cache implementation.

Parameters:

batchAnnotator - the batch annotator

cache - the cache

Method Detail

train

public void train(Annotated<OBJECT,ANNOTATION> annotated)

Description copied from interface: IncrementalTrainer

Train/update object using a new instance.

Parameters:

annotated - instance to train with

reset

public void reset()

Description copied from interface: IncrementalTrainer

Reset the object to its initial condition, as if it hasn't seen any training data.

getAnnotations

public Set<ANNOTATION> getAnnotations()

Returns:

a Set of all annotations this Annotator knows about

annotate

public List<ScoredAnnotation<ANNOTATION>> annotate(OBJECT object)

Description copied from interface: Annotator

Generate annotations for the given object.

Parameters:

object - the image

Returns:

generated annotations