org.jpmml.evaluator

Class ModelEvaluator<M extends org.dmg.pmml.Model>

java.lang.Object

org.jpmml.evaluator.PMMLManager

org.jpmml.evaluator.ModelManager<M>

org.jpmml.evaluator.ModelEvaluator<M>

All Implemented Interfaces:

Serializable, Consumer, Evaluator

Direct Known Subclasses:

AssociationModelEvaluator, ClusteringModelEvaluator, GeneralRegressionModelEvaluator, MiningModelEvaluator, NaiveBayesModelEvaluator, NearestNeighborModelEvaluator, NeuralNetworkEvaluator, RegressionModelEvaluator, RuleSetModelEvaluator, ScorecardEvaluator, SupportVectorMachineModelEvaluator, TreeModelEvaluator

public abstract class ModelEvaluator<M extends org.dmg.pmml.Model>
extends ModelManager<M>
implements Evaluator

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModelEvaluator(org.dmg.pmml.PMML pmml, Class<? extends M> clazz)
ModelEvaluator(org.dmg.pmml.PMML pmml, M model)

Method Summary

Methods

Modifier and Type	Method and Description
ModelEvaluationContext	createContext(ModelEvaluationContext parent)
Map<org.dmg.pmml.FieldName,?>	evaluate(Map<org.dmg.pmml.FieldName,?> arguments) Evaluates the model with the specified arguments.
abstract Map<org.dmg.pmml.FieldName,?>	evaluate(ModelEvaluationContext context)
protected org.dmg.pmml.DataField	getDataField()
org.dmg.pmml.DataField	getDataField(org.dmg.pmml.FieldName name) Gets the definition of a field from the DataDictionary.
<V> V	getValue(Callable<? extends V> loader, com.google.common.cache.Cache<M,V> cache)
<V> V	getValue(com.google.common.cache.LoadingCache<M,V> cache)
FieldValue	prepare(org.dmg.pmml.FieldName name, Object value) Prepares the input value for a field.
void	verify() Verifies the model.

Methods inherited from class org.jpmml.evaluator.ModelManager

getActiveFields, getGroupFields, getLocalDerivedField, getMiningField, getMiningFields, getMiningFunction, getModel, getOrderFields, getOutputField, getOutputFields, getSummary, getTarget, getTargetField, getTargetFields, resolveDerivedField

Methods inherited from class org.jpmml.evaluator.PMMLManager

getDerivedField, getFunction, getPMML

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.evaluator.Consumer

getActiveFields, getGroupFields, getMiningField, getMiningFunction, getOrderFields, getOutputField, getOutputFields, getSummary, getTarget, getTargetField, getTargetFields

Constructor Detail

ModelEvaluator

public ModelEvaluator(org.dmg.pmml.PMML pmml,
              Class<? extends M> clazz)

ModelEvaluator

public ModelEvaluator(org.dmg.pmml.PMML pmml,
              M model)

Method Detail

evaluate

public abstract Map<org.dmg.pmml.FieldName,?> evaluate(ModelEvaluationContext context)

getDataField

public org.dmg.pmml.DataField getDataField(org.dmg.pmml.FieldName name)

Description copied from interface: Consumer

Gets the definition of a field from the DataDictionary.

Specified by:

getDataField in interface Consumer

Overrides:

getDataField in class PMMLManager

Parameters:

name - The name of the field. The name of the default target field is null.

getDataField

protected org.dmg.pmml.DataField getDataField()

Returns:

A synthetic DataField describing the default target field.

prepare

public FieldValue prepare(org.dmg.pmml.FieldName name,
                 Object value)

Description copied from interface: Evaluator

Prepares the input value for a field.

First, the value is converted from the user-supplied representation to internal representation. After that, the value is subjected to missing value treatment, invalid value treatment and outlier treatment.

Specified by:

prepare in interface Evaluator

Parameters:

name - The name of the field

See Also:

Consumer.getDataField(FieldName), Consumer.getMiningField(FieldName)

verify

public void verify()

Description copied from interface: Evaluator

Verifies the model.

Specified by:

verify in interface Evaluator

createContext

public ModelEvaluationContext createContext(ModelEvaluationContext parent)

evaluate

public Map<org.dmg.pmml.FieldName,?> evaluate(Map<org.dmg.pmml.FieldName,?> arguments)

Description copied from interface: Evaluator

Evaluates the model with the specified arguments.

Specified by:

evaluate in interface Evaluator

Parameters:

arguments - Map of active field values.

Returns:

Map of target field and output field values. Simple values are represented using the Java equivalents of PMML data types (eg. String, Integer, Float, Double etc.). Complex values are represented as instances of Computable that return simple values. A missing result is represented by null.

See Also:

Computable

getValue

public <V> V getValue(com.google.common.cache.LoadingCache<M,V> cache)

getValue

public <V> V getValue(Callable<? extends V> loader,
             com.google.common.cache.Cache<M,V> cache)