org.jpmml.evaluator

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

java.lang.Object

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 Object
implements Evaluator, HasModel<M>, Serializable

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(org.dmg.pmml.PMML pmml, M model)

Method Summary

Modifier and Type	Method and Description
protected boolean	assessParentCompatibility()
protected boolean	assessPurity()
protected Set<org.dmg.pmml.ResultFeature>	collectResultFeatures()
void	configure(Configuration configuration) Configures the runtime behaviour of this model evaluator.
protected <V extends Number> Classification<V>	createClassification(ValueMap<String,V> values)
ModelEvaluationContext	createEvaluationContext()
protected List<InputField>	createInputFields()
protected List<InputField>	createInputFields(org.dmg.pmml.MiningField.UsageType usageType)
protected EvaluationException	createMiningSchemaException(String message)
protected List<OutputField>	createOutputFields()
protected List<TargetField>	createTargetFields()
protected Configuration	ensureConfiguration()
protected ModelEvaluatorFactory	ensureModelEvaluatorFactory()
protected Predicate<org.dmg.pmml.OutputField>	ensureOutputFilter()
protected ValueFactory<?>	ensureValueFactory()
protected ValueFactoryFactory	ensureValueFactoryFactory()
Map<org.dmg.pmml.FieldName,?>	evaluate(Map<org.dmg.pmml.FieldName,?> arguments) Evaluates the model with the specified arguments.
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateAssociationRules(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateClassification(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateClustering(ValueFactory<V> valueFactory, EvaluationContext context)
Map<org.dmg.pmml.FieldName,?>	evaluateInternal(ModelEvaluationContext context)
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateMixed(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateRegression(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateSequences(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends Number> Map<org.dmg.pmml.FieldName,?>	evaluateTimeSeries(ValueFactory<V> valueFactory, EvaluationContext context)
List<InputField>	getActiveFields() Gets the independent (ie. input) fields of a Model from its MiningSchema.
Configuration	getConfiguration()
protected org.dmg.pmml.DataField	getDataField()
org.dmg.pmml.DataField	getDataField(org.dmg.pmml.FieldName name)
org.dmg.pmml.DefineFunction	getDefineFunction(String name)
org.dmg.pmml.DerivedField	getDerivedField(org.dmg.pmml.FieldName name)
List<InputField>	getInputFields()
InputMapper	getInputMapper()
org.dmg.pmml.DerivedField	getLocalDerivedField(org.dmg.pmml.FieldName name)
org.dmg.pmml.MathContext	getMathContext()
org.dmg.pmml.MiningField	getMiningField(org.dmg.pmml.FieldName name)
org.dmg.pmml.MiningFunction	getMiningFunction() Gets the type of the Model.
M	getModel()
org.dmg.pmml.OutputField	getOutputField(org.dmg.pmml.FieldName name)
List<OutputField>	getOutputFields() Gets the output fields of a Model from its Output.
org.dmg.pmml.PMML	getPMML()
Set<org.dmg.pmml.ResultFeature>	getResultFeatures()
ResultMapper	getResultMapper()
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name)
TargetField	getTargetField()
List<TargetField>	getTargetFields() Gets the dependent (ie. target in supervised training) fields of a Model from its MiningSchema.
org.dmg.pmml.FieldName	getTargetName()
<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)
boolean	hasResultFeature(org.dmg.pmml.ResultFeature resultFeature) Indicates if this model evaluator provides the specified result feature.
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<org.dmg.pmml.FieldName,?>	processArguments(Map<org.dmg.pmml.FieldName,?> arguments)
protected Map<org.dmg.pmml.FieldName,?>	processResults(Map<org.dmg.pmml.FieldName,?> results)
protected org.dmg.pmml.Field<?>	resolveField(org.dmg.pmml.FieldName name)
ModelEvaluator<M>	verify() Verifies the model.

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

getSummary

Constructor Detail

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.

getMiningFunction

public org.dmg.pmml.MiningFunction getMiningFunction()

Description copied from interface: Evaluator

Gets the type of the Model.

Specified by:

getMiningFunction in interface Evaluator

getMathContext

public org.dmg.pmml.MathContext getMathContext()

getDataField

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

getDataField

protected org.dmg.pmml.DataField getDataField()

Returns:

A synthetic DataField element describing the default target field.

getDerivedField

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

getDefineFunction

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

getMiningField

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

getLocalDerivedField

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

getTarget

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

getOutputField

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

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.

getInputFields

public List<InputField> getInputFields()

Specified by:

getInputFields in interface HasInputFields

getActiveFields

public List<InputField> getActiveFields()

Description copied from interface: HasActiveFields

Gets the independent (ie. input) fields of a Model from its MiningSchema.

Specified by:

getActiveFields in interface HasActiveFields

getTargetFields

public List<TargetField> getTargetFields()

Description copied from interface: HasResultFields

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

Specified by:

getTargetFields in interface HasResultFields

getTargetField

public TargetField getTargetField()

getTargetName

public org.dmg.pmml.FieldName getTargetName()

getOutputFields

public List<OutputField> getOutputFields()

Description copied from interface: HasResultFields

Gets the output fields of a Model from its Output.

Specified by:

getOutputFields in interface HasResultFields

hasResultFeature

public boolean hasResultFeature(org.dmg.pmml.ResultFeature resultFeature)

Indicates if this model evaluator provides the specified result feature.

A result feature is first and foremost manifested through output fields. However, selected result features may make a secondary manifestation through a target field.

See Also:

OutputField.getResultFeature()

getResultFeatures

public Set<org.dmg.pmml.ResultFeature> getResultFeatures()

createMiningSchemaException

protected EvaluationException createMiningSchemaException(String message)

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<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 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<org.dmg.pmml.FieldName,?> processArguments(Map<org.dmg.pmml.FieldName,?> arguments)

processResults

protected Map<org.dmg.pmml.FieldName,?> processResults(Map<org.dmg.pmml.FieldName,?> results)

evaluateInternal

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

evaluateRegression

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateRegression(ValueFactory<V> valueFactory,
                                                                              EvaluationContext context)

evaluateClassification

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateClassification(ValueFactory<V> valueFactory,
                                                                                  EvaluationContext context)

evaluateClustering

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateClustering(ValueFactory<V> valueFactory,
                                                                              EvaluationContext context)

evaluateAssociationRules

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateAssociationRules(ValueFactory<V> valueFactory,
                                                                                    EvaluationContext context)

evaluateSequences

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateSequences(ValueFactory<V> valueFactory,
                                                                             EvaluationContext context)

evaluateTimeSeries

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateTimeSeries(ValueFactory<V> valueFactory,
                                                                              EvaluationContext context)

evaluateMixed

protected <V extends Number> Map<org.dmg.pmml.FieldName,?> evaluateMixed(ValueFactory<V> valueFactory,
                                                                         EvaluationContext context)

createClassification

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

assessParentCompatibility

protected boolean assessParentCompatibility()

assessPurity

protected boolean assessPurity()

createInputFields

protected List<InputField> createInputFields()

createInputFields

protected List<InputField> createInputFields(org.dmg.pmml.MiningField.UsageType usageType)

createTargetFields

protected List<TargetField> createTargetFields()

createOutputFields

protected List<OutputField> createOutputFields()

collectResultFeatures

protected Set<org.dmg.pmml.ResultFeature> collectResultFeatures()

resolveField

protected org.dmg.pmml.Field<?> resolveField(org.dmg.pmml.FieldName name)

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)

ensureConfiguration

protected Configuration ensureConfiguration()

ensureModelEvaluatorFactory

protected ModelEvaluatorFactory ensureModelEvaluatorFactory()

ensureValueFactoryFactory

protected ValueFactoryFactory ensureValueFactoryFactory()

ensureOutputFilter

protected Predicate<org.dmg.pmml.OutputField> ensureOutputFilter()

ensureValueFactory

protected ValueFactory<?> ensureValueFactory()

getPMML

public org.dmg.pmml.PMML getPMML()

Specified by:

getPMML in interface HasPMML

getModel

public M getModel()

Specified by:

getModel in interface HasModel<M extends org.dmg.pmml.Model>

getConfiguration

public Configuration getConfiguration()

getInputMapper

public InputMapper getInputMapper()

getResultMapper

public ResultMapper getResultMapper()