Package org.tribuo.classification.sequence.viterbi

Class ViterbiModel

java.lang.Object

org.tribuo.sequence.SequenceModel<Label>

org.tribuo.classification.sequence.viterbi.ViterbiModel

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.provenance.Provenancable<ModelProvenance>, Serializable

public class ViterbiModel
extends SequenceModel<Label>

An implementation of a viterbi model.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ViterbiModel.ScoreAggregation	Types of label score aggregation.

Field Summary

Fields inherited from class org.tribuo.sequence.SequenceModel

featureIDMap, name, outputIDMap, provenanceOutput

Method Summary

Modifier and Type	Method	Description
ViterbiModel.ScoreAggregation	getScoreAggregation()	Gets the score aggregation function.
int	getStackSize()	Gets the stack size of this model.
Map<String,List<com.oracle.labs.mlrg.olcut.util.Pair<String,Double>>>	getTopFeatures(int n)
protected List<Label>	getTopLabels(Map<String,Label> distribution)
protected static List<Label>	getTopLabels(Map<String,Label> distribution, int stackSize)
List<List<Prediction<Label>>>	predict(SequenceDataset<Label> examples)
List<Prediction<Label>>	predict(SequenceExample<Label> examples)

Methods inherited from class org.tribuo.sequence.SequenceModel

getFeatureIDMap, getName, getOutputIDInfo, getProvenance, predict, setName, toMaxLabels, toString, validate

Methods inherited from class java.lang.Object

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

Method Details

predict

public List<List<Prediction<Label>>> predict(SequenceDataset<Label> examples)

Overrides:

predict in class SequenceModel<Label>

predict

public List<Prediction<Label>> predict(SequenceExample<Label> examples)

Specified by:

predict in class SequenceModel<Label>

getTopLabels

protected List<Label> getTopLabels(Map<String,Label> distribution)

getTopLabels

protected static List<Label> getTopLabels(Map<String,Label> distribution,
 int stackSize)

getStackSize

public int getStackSize()

Gets the stack size of this model.

Returns:

The stack size.

getScoreAggregation

public ViterbiModel.ScoreAggregation getScoreAggregation()

Gets the score aggregation function.

Returns:

The score aggregation function.

getTopFeatures

public Map<String,List<com.oracle.labs.mlrg.olcut.util.Pair<String,Double>>> getTopFeatures(int n)

Specified by:

getTopFeatures in class SequenceModel<Label>