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

Field Summary

Fields inherited from class org.jpmml.evaluator.ModelManager

ACTIVE_TYPES, GROUP_TYPES, ORDER_TYPES, TARGET_TYPES

Fields inherited from interface org.jpmml.evaluator.Evaluator

DEFAULT_TARGET

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
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.
org.dmg.pmml.DefineFunction	getDefineFunction(String name)
org.dmg.pmml.DerivedField	getDerivedField(org.dmg.pmml.FieldName name)
org.dmg.pmml.DerivedField	getLocalDerivedField(org.dmg.pmml.FieldName name)
org.dmg.pmml.MiningField	getMiningField(org.dmg.pmml.FieldName name) Gets the definition of a field from the MiningSchema.
protected List<org.dmg.pmml.FieldName>	getMiningFields(EnumSet<org.dmg.pmml.FieldUsageType> types)
org.dmg.pmml.OutputField	getOutputField(org.dmg.pmml.FieldName name) Gets the definition of a field from the Output
List<org.dmg.pmml.FieldName>	getOutputFields() Gets the output fields of a Model from its Output.
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name) Gets the definition of a field from the Targets.
org.dmg.pmml.FieldName	getTargetField() Convenience method for retrieving the sole target field.
List<org.dmg.pmml.FieldName>	getTargetFields() Gets the dependent (ie. target in supervised training) fields of a Model from its MiningSchema.
<V> V	getValue(com.google.common.cache.Cache<M,V> cache, Callable<? extends V> loader)
<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, getMiningFunction, getModel, getOrderFields, getSummary

Methods inherited from class org.jpmml.evaluator.PMMLManager

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, getMiningFunction, getOrderFields, getSummary

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

Specified by:

getDataField in interface Evaluator

Overrides:

getDataField in class PMMLManager

Parameters:

name - The name of the field. Use Evaluator.DEFAULT_TARGET to represent the default target field.

getDataField

protected org.dmg.pmml.DataField getDataField()

Returns:

A synthetic DataField describing the default target field.

getDerivedField

public org.dmg.pmml.DerivedField getDerivedField(org.dmg.pmml.FieldName name)

Overrides:

getDerivedField in class PMMLManager

getDefineFunction

public org.dmg.pmml.DefineFunction getDefineFunction(String name)

Overrides:

getDefineFunction in class PMMLManager

getTargetFields

public List<org.dmg.pmml.FieldName> getTargetFields()

Description copied from interface: Consumer

Gets the dependent (ie. target in supervised training) fields of a Model from its MiningSchema.

Specified by:

getTargetFields in interface Consumer

Overrides:

getTargetFields in class ModelManager<M extends org.dmg.pmml.Model>

See Also:

Consumer.getTarget(FieldName)

getTargetField

public org.dmg.pmml.FieldName getTargetField()

Description copied from interface: Evaluator

Convenience method for retrieving the sole target field.

A supervised model should, but is not required to, define a target field. An unsupervised model, by definition, does not define a target field. If the collection of target fields is empty, then the model consumer should assume that the model defines a default target field, which is represented by Evaluator.DEFAULT_TARGET.

The default target field could be either "real" or "phantom". They can be distinguished from one another by looking up the definition of the field from the DataDictionary.

 Consumer consumer = ...;

 List<FieldName> targetFields = consumer.getTargetFields();
 if(targetFields.isEmpty()){
   FieldName targetField = consumer.getTargetField();

   DataField dataField = consumer.getDataField(targetField);
   if(dataField != null){
     // A "real" default target field
   } else

   {
     // A "phantom" default target field
   }
 }
 

Specified by:

getTargetField in interface Evaluator

Returns:

The sole target field.

See Also:

Consumer.getTargetFields()

getMiningField

public org.dmg.pmml.MiningField getMiningField(org.dmg.pmml.FieldName name)

Description copied from interface: Consumer

Gets the definition of a field from the MiningSchema.

Specified by:

getMiningField in interface Consumer

Overrides:

getMiningField in class ModelManager<M extends org.dmg.pmml.Model>

Parameters:

name - The name of the field.

See Also:

Consumer.getActiveFields(), Consumer.getGroupFields(), Consumer.getOrderFields(), Consumer.getTargetFields()

getMiningFields

protected List<org.dmg.pmml.FieldName> getMiningFields(EnumSet<org.dmg.pmml.FieldUsageType> types)

Overrides:

getMiningFields in class ModelManager<M extends org.dmg.pmml.Model>

getLocalDerivedField

public org.dmg.pmml.DerivedField getLocalDerivedField(org.dmg.pmml.FieldName name)

Overrides:

getLocalDerivedField in class ModelManager<M extends org.dmg.pmml.Model>

getTarget

public org.dmg.pmml.Target getTarget(org.dmg.pmml.FieldName name)

Description copied from interface: Consumer

Gets the definition of a field from the Targets.

Specified by:

getTarget in interface Consumer

Overrides:

getTarget in class ModelManager<M extends org.dmg.pmml.Model>

See Also:

Consumer.getTargetFields()

getOutputFields

public List<org.dmg.pmml.FieldName> getOutputFields()

Description copied from interface: Consumer

Gets the output fields of a Model from its Output.

Specified by:

getOutputFields in interface Consumer

Overrides:

getOutputFields in class ModelManager<M extends org.dmg.pmml.Model>

See Also:

Consumer.getOutputField(FieldName)

getOutputField

public org.dmg.pmml.OutputField getOutputField(org.dmg.pmml.FieldName name)

Description copied from interface: Consumer

Gets the definition of a field from the Output

Specified by:

getOutputField in interface Consumer

Overrides:

getOutputField in class ModelManager<M extends org.dmg.pmml.Model>

See Also:

Consumer.getOutputFields()

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:

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

verify

public void verify()

Description copied from interface: Evaluator

Verifies the model.

Specified by:

verify in interface Evaluator

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. A target field could be mapped to a complex value or a simple value. An output field is always mapped to a simple value. Complex values are represented as instances of Computable that return simple values. Simple values are represented using the Java equivalents of PMML data types (eg. String, Integer, Float, Double etc.). A missing value 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(com.google.common.cache.Cache<M,V> cache,
             Callable<? extends V> loader)