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, Evaluator, HasActiveFields, HasInputFields, HasModel<M>, HasPMML, HasResultFields

Direct Known Subclasses:

AssociationModelEvaluator, ClusteringModelEvaluator, GeneralRegressionModelEvaluator, JavaModelEvaluator, 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:

ModelEvaluatorBuilder, Serialized Form

Field Summary

Fields inherited from interface org.jpmml.evaluator.Evaluator

DEFAULT_TARGET_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelEvaluator()
protected	ModelEvaluator(org.dmg.pmml.PMML pmml, M model)

Method Summary

Modifier and Type	Method and Description
protected boolean	assessParentCompatibility()
protected boolean	assessPurity()
void	configure(Configuration configuration) Configures the runtime behaviour of this model evaluator.
protected <V extends Number> Classification<Object,V>	createClassification(ValueMap<Object,V> values)
ModelEvaluationContext	createEvaluationContext()
protected Configuration	ensureConfiguration()
protected ModelEvaluatorFactory	ensureModelEvaluatorFactory()
protected OutputFilter	ensureOutputFilter()
protected ValueFactory<?>	ensureValueFactory()
protected ValueFactoryFactory	ensureValueFactoryFactory()
Map<String,?>	evaluate(Map<String,?> arguments) Evaluates the model with the specified arguments.
protected <V extends Number> Map<String,?>	evaluateAssociationRules(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<String,?>	evaluateClassification(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<String,?>	evaluateClustering(ValueFactory<V> valueFactory, EvaluationContext context)
Map<String,?>	evaluateInternal(ModelEvaluationContext context)
protected <V extends Number> Map<String,?>	evaluateMixed(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<String,?>	evaluateRegression(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<String,?>	evaluateSequences(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<String,?>	evaluateTimeSeries(ValueFactory<V> valueFactory, EvaluationContext context)
protected List<InputField>	filterInputFields(List<InputField> inputFields)
protected List<OutputField>	filterOutputFields(List<OutputField> outputFields)
protected List<TargetField>	filterTargetFields(List<TargetField> targetFields)
Configuration	getConfiguration()
InputMapper	getInputMapper()
protected int	getNumberOfVisibleFields()
ResultMapper	getResultMapper()
boolean	isParentCompatible() Indicates if this model evaluator is compatible with its parent model evaluator.
boolean	isPure() Indicates if this model evaluator represents a pure function.
protected Map<String,?>	processArguments(Map<String,?> arguments)
protected Map<String,?>	processResults(Map<String,?> results)
ModelEvaluator<M>	verify() Verifies the model.

Methods inherited from class org.jpmml.evaluator.ModelManager

addResultFeatures, collectResultFeatures, collectSegmentResultFeatures, createInputFields, createInputFields, createMiningSchemaException, createOutputFields, createTargetFields, getActiveFields, getDataField, getDefaultDataField, getInputFields, getLocalDerivedField, getMathContext, getMiningField, getMiningFunction, getModel, getOutputField, getOutputFields, getResultFeatures, getTarget, getTargetField, getTargetFields, getTargetName, getVisibleFields, hasLocalDerivedFields, hasOutputFields, hasResultFeature, resetInputFields, resetResultFields, resolveField, setDefaultDataField

Methods inherited from class org.jpmml.evaluator.PMMLManager

getDefineFunction, getDerivedField, getPMML, toImmutableListMap, toImmutableMapMap, toImmutableSetMap

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.Evaluator

getMiningFunction, getSummary

Methods inherited from interface org.jpmml.evaluator.HasInputFields

getInputFields

Methods inherited from interface org.jpmml.evaluator.HasActiveFields

getActiveFields

Methods inherited from interface org.jpmml.evaluator.HasResultFields

getOutputFields, getTargetFields

Methods inherited from interface org.jpmml.evaluator.HasPMML

getPMML

Constructor Detail

ModelEvaluator

protected ModelEvaluator()

ModelEvaluator

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

Method Detail

configure

public void configure(Configuration configuration)

Configures the runtime behaviour of this model evaluator.

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

isParentCompatible

public boolean isParentCompatible()

Indicates if this model evaluator is compatible with its parent model evaluator.

A parent compatible model evaluator inherits DataField declarations unchanged, which makes it possible to propagate DataField and global DerivedField values between evaluation contexts during evaluation.

isPure

public boolean isPure()

Indicates if this model evaluator represents a pure function.

A pure model evaluator does not tamper with the evaluation context during evaluation.

getNumberOfVisibleFields

protected int getNumberOfVisibleFields()

verify

public ModelEvaluator<M> verify()

Description copied from interface: Evaluator

Verifies the model.

Specified by:

verify in interface Evaluator

createEvaluationContext

public ModelEvaluationContext createEvaluationContext()

evaluate

public Map<String,?> evaluate(Map<String,?> arguments)

Description copied from interface: Evaluator

Evaluates the model with the specified arguments.

Specified by:

evaluate in interface Evaluator

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

processArguments

protected Map<String,?> processArguments(Map<String,?> arguments)

processResults

protected Map<String,?> processResults(Map<String,?> results)

filterInputFields

protected List<InputField> filterInputFields(List<InputField> inputFields)

Overrides:

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

filterTargetFields

protected List<TargetField> filterTargetFields(List<TargetField> targetFields)

Overrides:

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

filterOutputFields

protected List<OutputField> filterOutputFields(List<OutputField> outputFields)

Overrides:

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

evaluateInternal

public Map<String,?> evaluateInternal(ModelEvaluationContext context)

evaluateRegression

protected <V extends Number> Map<String,?> evaluateRegression(ValueFactory<V> valueFactory,
                                                              EvaluationContext context)

evaluateClassification

protected <V extends Number> Map<String,?> evaluateClassification(ValueFactory<V> valueFactory,
                                                                  EvaluationContext context)

evaluateClustering

protected <V extends Number> Map<String,?> evaluateClustering(ValueFactory<V> valueFactory,
                                                              EvaluationContext context)

evaluateAssociationRules

protected <V extends Number> Map<String,?> evaluateAssociationRules(ValueFactory<V> valueFactory,
                                                                    EvaluationContext context)

evaluateSequences

protected <V extends Number> Map<String,?> evaluateSequences(ValueFactory<V> valueFactory,
                                                             EvaluationContext context)

evaluateTimeSeries

protected <V extends Number> Map<String,?> evaluateTimeSeries(ValueFactory<V> valueFactory,
                                                              EvaluationContext context)

evaluateMixed

protected <V extends Number> Map<String,?> evaluateMixed(ValueFactory<V> valueFactory,
                                                         EvaluationContext context)

createClassification

protected <V extends Number> Classification<Object,V> createClassification(ValueMap<Object,V> values)

assessParentCompatibility

protected boolean assessParentCompatibility()

assessPurity

protected boolean assessPurity()

ensureConfiguration

protected Configuration ensureConfiguration()

ensureModelEvaluatorFactory

protected ModelEvaluatorFactory ensureModelEvaluatorFactory()

ensureValueFactoryFactory

protected ValueFactoryFactory ensureValueFactoryFactory()

ensureOutputFilter

protected OutputFilter ensureOutputFilter()

ensureValueFactory

protected ValueFactory<?> ensureValueFactory()

getConfiguration

public Configuration getConfiguration()

getInputMapper

public InputMapper getInputMapper()

getResultMapper

public ResultMapper getResultMapper()