org.tribuo.ensemble

Class WeightedEnsembleModel<T extends Output<T>>

java.lang.Object

org.tribuo.Model<T>

org.tribuo.ensemble.EnsembleModel<T>

org.tribuo.ensemble.WeightedEnsembleModel<T>

All Implemented Interfaces:

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

public final class WeightedEnsembleModel<T extends Output<T>>
extends EnsembleModel<T>

An ensemble model that uses weights to combine the ensemble member predictions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected EnsembleCombiner<T>	combiner
protected float[]	weights

Fields inherited from class org.tribuo.ensemble.EnsembleModel

models

Fields inherited from class org.tribuo.Model

ALL_OUTPUTS, BIAS_FEATURE, featureIDMap, generatesProbabilities, name, outputIDInfo, provenance, provenanceOutput

Constructor Summary

Constructors

Constructor and Description
WeightedEnsembleModel(String name, EnsembleModelProvenance description, ImmutableFeatureMap featureIDMap, ImmutableOutputInfo<T> outputIDInfo, List<Model<T>> newModels, EnsembleCombiner<T> combiner)
WeightedEnsembleModel(String name, EnsembleModelProvenance description, ImmutableFeatureMap featureIDMap, ImmutableOutputInfo<T> outputIDInfo, List<Model<T>> newModels, EnsembleCombiner<T> combiner, float[] weights)

Method Summary

Modifier and Type	Method and Description
protected EnsembleModel<T>	copy(String name, EnsembleModelProvenance newProvenance, List<Model<T>> newModels)
Optional<Excuse<T>>	getExcuse(Example<T> example) Generates an excuse for an example.
Prediction<T>	predict(Example<T> example) Uses the model to predict the output for a single example.

Methods inherited from class org.tribuo.ensemble.EnsembleModel

copy, getModels, getNumModels, getProvenance, getTopFeatures

Methods inherited from class org.tribuo.Model

copy, generatesProbabilities, getExcuses, getFeatureIDMap, getName, getOutputIDInfo, innerPredict, predict, predict, setName, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

weights

protected final float[] weights

combiner

protected final EnsembleCombiner<T extends Output<T>> combiner

Constructor Detail

WeightedEnsembleModel

public WeightedEnsembleModel(String name,
                             EnsembleModelProvenance description,
                             ImmutableFeatureMap featureIDMap,
                             ImmutableOutputInfo<T> outputIDInfo,
                             List<Model<T>> newModels,
                             EnsembleCombiner<T> combiner)

WeightedEnsembleModel

public WeightedEnsembleModel(String name,
                             EnsembleModelProvenance description,
                             ImmutableFeatureMap featureIDMap,
                             ImmutableOutputInfo<T> outputIDInfo,
                             List<Model<T>> newModels,
                             EnsembleCombiner<T> combiner,
                             float[] weights)

Method Detail

predict

public Prediction<T> predict(Example<T> example)

Description copied from class: Model

Uses the model to predict the output for a single example.

predict does not mutate the example.

Throws IllegalArgumentException if the example has no features or no feature overlap with the model.

Specified by:

predict in class Model<T extends Output<T>>

Parameters:

example - the example to predict.

Returns:

the result of the prediction.

getExcuse

public Optional<Excuse<T>> getExcuse(Example<T> example)

Description copied from class: Model

Generates an excuse for an example.

This attempts to explain a classification result. Generating an excuse may be quite an expensive operation.

This excuse either contains per class information or an entry with key Model.ALL_OUTPUTS.

The optional is empty if the model does not provide excuses.

Specified by:

getExcuse in class EnsembleModel<T extends Output<T>>

Parameters:

example - The input example.

Returns:

An optional excuse object. The optional is empty if this model does not provide excuses.

copy

protected EnsembleModel<T> copy(String name,
                                EnsembleModelProvenance newProvenance,
                                List<Model<T>> newModels)

Specified by:

copy in class EnsembleModel<T extends Output<T>>