org.jpmml.evaluator.mining

Class MiningModelEvaluator

java.lang.Object

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

org.jpmml.evaluator.mining.MiningModelEvaluator

All Implemented Interfaces:

Serializable, Evaluator, HasActiveFields, HasEntityRegistry<org.dmg.pmml.mining.Segment>, HasInputFields, HasModel<org.dmg.pmml.mining.MiningModel>, HasPMML, HasResultFields

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jpmml.evaluator.Evaluator

DEFAULT_TARGET_NAME

Constructor Summary

Constructors

Constructor and Description
MiningModelEvaluator(org.dmg.pmml.PMML pmml)
MiningModelEvaluator(org.dmg.pmml.PMML pmml, org.dmg.pmml.mining.MiningModel miningModel)

Method Summary

Modifier and Type	Method and Description
void	configure(ModelEvaluatorFactory modelEvaluatorFactory) Configures the runtime behaviour of this Evaluator instance.
protected List<OutputField>	createOutputFields()
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.mining.Segment>	getEntityRegistry()
String	getSummary() Gets a short description of the Model.
org.dmg.pmml.FieldName	getTargetFieldName()
boolean	isPrimitive()

Methods inherited from class org.jpmml.evaluator.ModelEvaluator

createInputFields, createInputFields, createMiningSchemaException, createTargetFields, ensureModelEvaluatorFactory, ensureScorableModel, ensureValueFactory, ensureValueFactoryFactory, getActiveFields, getDataField, getDefineFunction, getDerivedField, getInputFields, getLocalDerivedField, getMathContext, getMiningField, getMiningFunction, getModel, getModelEvaluatorFactory, getOutputField, getOutputFields, getPMML, getTarget, getTargetField, getTargetFields, getValue, getValue, getValueFactory, getValueFactoryFactory, resolveDerivedField, resolveField, selectModel, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

MiningModelEvaluator

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

MiningModelEvaluator

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

Method Detail

configure

public void configure(ModelEvaluatorFactory modelEvaluatorFactory)

Description copied from class: ModelEvaluator

Configures the runtime behaviour of this Evaluator instance.

Must be called once before the first evaluation. May be called any number of times between subsequent evaluations.

Overrides:

configure in class ModelEvaluator<org.dmg.pmml.mining.MiningModel>

getSummary

public String getSummary()

Description copied from interface: Evaluator

Gets a short description of the Model.

Specified by:

getSummary in interface Evaluator

getDataField

protected org.dmg.pmml.DataField getDataField()

Overrides:

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

Returns:

A synthetic DataField element describing the default target field.

isPrimitive

public boolean isPrimitive()

Overrides:

isPrimitive in class ModelEvaluator<org.dmg.pmml.mining.MiningModel>

getTargetFieldName

public org.dmg.pmml.FieldName getTargetFieldName()

Overrides:

getTargetFieldName in class ModelEvaluator<org.dmg.pmml.mining.MiningModel>

getEntityRegistry

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

Specified by:

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

Returns:

A bidirectional map between Entity identifiers and Entity instances.

createOutputFields

protected List<OutputField> createOutputFields()

Overrides:

createOutputFields in class ModelEvaluator<org.dmg.pmml.mining.MiningModel>

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.mining.MiningModel>

Parameters:

arguments - Map of input 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.mining.MiningModel>

evaluate

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