org.jpmml.evaluator

Class MiningModelEvaluator

java.lang.Object

org.jpmml.evaluator.PMMLManager

org.jpmml.evaluator.ModelManager<M>

org.jpmml.evaluator.ModelEvaluator<org.dmg.pmml.MiningModel>

org.jpmml.evaluator.MiningModelEvaluator

All Implemented Interfaces:

Serializable, Consumer, Evaluator, HasEntityRegistry<org.dmg.pmml.Segment>, MiningModelConsumer

public class MiningModelEvaluator
extends ModelEvaluator<org.dmg.pmml.MiningModel>
implements MiningModelConsumer, HasEntityRegistry<org.dmg.pmml.Segment>

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
MiningModelEvaluator(org.dmg.pmml.PMML pmml)
MiningModelEvaluator(org.dmg.pmml.PMML pmml, org.dmg.pmml.MiningModel miningModel)

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.
Map<org.dmg.pmml.FieldName,?>	evaluate(MiningModelEvaluationContext context)
Map<org.dmg.pmml.FieldName,?>	evaluate(ModelEvaluationContext context)
protected org.dmg.pmml.DataField	getDataField()
com.google.common.collect.BiMap<String,org.dmg.pmml.Segment>	getEntityRegistry()
ModelEvaluatorFactory	getEvaluatorFactory()
org.dmg.pmml.MultipleModelMethodType	getMultipleModelMethod() Gets the type of the MiningModel.
org.dmg.pmml.OutputField	getNestedOutputField(org.dmg.pmml.FieldName name) Gets the definition of a field from the nested Consumer instance.
List<org.dmg.pmml.FieldName>	getNestedOutputFields() Gets the output fields of nested Consumer instances.
String	getSummary() Gets a short description of the Model.
void	setEvaluatorFactory(ModelEvaluatorFactory evaluatorFactory)

Methods inherited from class org.jpmml.evaluator.ModelEvaluator

getDataField, getDefineFunction, getDerivedField, getLocalDerivedField, getMiningField, getMiningFields, getOutputField, getOutputFields, getTarget, getTargetField, getTargetFields, getValue, getValue, prepare, verify

Methods inherited from class org.jpmml.evaluator.ModelManager

getActiveFields, getGroupFields, getMiningFunction, getModel, getOrderFields

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, getDataField, getGroupFields, getMiningField, getMiningFunction, getOrderFields, getOutputField, getOutputFields, getTarget, getTargetFields

Constructor Detail

MiningModelEvaluator

public MiningModelEvaluator(org.dmg.pmml.PMML pmml)

MiningModelEvaluator

public MiningModelEvaluator(org.dmg.pmml.PMML pmml,
                    org.dmg.pmml.MiningModel miningModel)

Method Detail

getMultipleModelMethod

public org.dmg.pmml.MultipleModelMethodType getMultipleModelMethod()

Description copied from interface: MiningModelConsumer

Gets the type of the MiningModel.

The following MiningModel types propagate nested evaluation results to the top level:

• MultipleModelMethodType.SELECT_ALL
• MultipleModelMethodType.SELECT_FIRST
• MultipleModelMethodType.MODEL_CHAIN

Specified by:

getMultipleModelMethod in interface MiningModelConsumer

getNestedOutputFields

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

Description copied from interface: MiningModelConsumer

Gets the output fields of nested Consumer instances.

The target fields of nested models are subsets of target fields the top-level mining model. However, the output fields of nested models are disjoint sets from the output fields of the top-level mining model.

Specified by:

getNestedOutputFields in interface MiningModelConsumer

getNestedOutputField

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

Description copied from interface: MiningModelConsumer

Gets the definition of a field from the nested Consumer instance.

Specified by:

getNestedOutputField in interface MiningModelConsumer

See Also:

MiningModelConsumer.getNestedOutputFields()

getSummary

public String getSummary()

Description copied from interface: Consumer

Gets a short description of the Model.

Specified by:

getSummary in interface Consumer

Overrides:

getSummary in class ModelManager<org.dmg.pmml.MiningModel>

getDataField

protected org.dmg.pmml.DataField getDataField()

Overrides:

getDataField in class ModelEvaluator<org.dmg.pmml.MiningModel>

Returns:

A synthetic DataField describing the default target field.

getEntityRegistry

public com.google.common.collect.BiMap<String,org.dmg.pmml.Segment> getEntityRegistry()

Specified by:

getEntityRegistry in interface HasEntityRegistry<org.dmg.pmml.Segment>

Returns:

A bidirectional map between Entity identifiers and Entity instances.

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

Overrides:

evaluate in class ModelEvaluator<org.dmg.pmml.MiningModel>

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

evaluate

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

Specified by:

evaluate in class ModelEvaluator<org.dmg.pmml.MiningModel>

evaluate

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

getEvaluatorFactory

public ModelEvaluatorFactory getEvaluatorFactory()

setEvaluatorFactory

public void setEvaluatorFactory(ModelEvaluatorFactory evaluatorFactory)