org.jpmml.evaluator

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

java.lang.Object

org.jpmml.evaluator.ModelEvaluator<M>

All Implemented Interfaces:

java.io.Serializable, Evaluator, HasActiveFields, HasInputFields, 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 java.lang.Object
implements Evaluator, java.io.Serializable

See Also:

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

Methods

Modifier and Type	Method and Description
protected java.util.List<InputField>	createInputFields()
protected java.util.List<InputField>	createInputFields(org.dmg.pmml.MiningField.UsageType usageType)
protected java.util.List<OutputField>	createOutputFields()
protected java.util.List<TargetField>	createTargetFields()
java.util.Map<org.dmg.pmml.FieldName,?>	evaluate(java.util.Map<org.dmg.pmml.FieldName,?> arguments) Evaluates the model with the specified arguments.
abstract java.util.Map<org.dmg.pmml.FieldName,?>	evaluate(ModelEvaluationContext context)
java.util.List<InputField>	getActiveFields() Gets the independent (ie. input) fields of a Model from its MiningSchema.
protected org.dmg.pmml.DataField	getDataField()
org.dmg.pmml.DataField	getDataField(org.dmg.pmml.FieldName name)
org.dmg.pmml.DefineFunction	getDefineFunction(java.lang.String name)
org.dmg.pmml.DerivedField	getDerivedField(org.dmg.pmml.FieldName name)
java.util.List<InputField>	getInputFields()
org.dmg.pmml.DerivedField	getLocalDerivedField(org.dmg.pmml.FieldName name)
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)
java.util.List<OutputField>	getOutputFields() Gets the output fields of a Model from its Output.
org.dmg.pmml.PMML	getPMML()
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name)
TargetField	getTargetField()
org.dmg.pmml.FieldName	getTargetFieldName()
java.util.List<TargetField>	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, java.util.concurrent.Callable<? extends V> loader)
<V> V	getValue(com.google.common.cache.LoadingCache<M,V> cache)
protected org.dmg.pmml.DerivedField	resolveDerivedField(org.dmg.pmml.FieldName name)
protected org.dmg.pmml.TypeDefinitionField	resolveField(org.dmg.pmml.FieldName name)
protected static <M extends org.dmg.pmml.Model> M	selectModel(org.dmg.pmml.PMML pmml, java.lang.Class<? extends M> clazz)
void	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

evaluate

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

getMiningFunction

public org.dmg.pmml.MiningFunction getMiningFunction()

Description copied from interface: Evaluator

Gets the type of the Model.

Specified by:

getMiningFunction in interface Evaluator

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(java.lang.String name)

getMiningField

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

getInputFields

public java.util.List<InputField> getInputFields()

Specified by:

getInputFields in interface HasInputFields

getActiveFields

public java.util.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

getLocalDerivedField

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

getTarget

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

getTargetFields

public java.util.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()

getTargetFieldName

public org.dmg.pmml.FieldName getTargetFieldName()

getOutputField

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

getOutputFields

public java.util.List<OutputField> getOutputFields()

Description copied from interface: HasResultFields

Gets the output fields of a Model from its Output.

Specified by:

getOutputFields in interface HasResultFields

verify

public void verify()

Description copied from interface: Evaluator

Verifies the model.

Specified by:

verify in interface Evaluator

evaluate

public java.util.Map<org.dmg.pmml.FieldName,?> evaluate(java.util.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

resolveField

protected org.dmg.pmml.TypeDefinitionField resolveField(org.dmg.pmml.FieldName name)

resolveDerivedField

protected org.dmg.pmml.DerivedField resolveDerivedField(org.dmg.pmml.FieldName name)

createInputFields

protected java.util.List<InputField> createInputFields()

createInputFields

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

createTargetFields

protected java.util.List<TargetField> createTargetFields()

createOutputFields

protected java.util.List<OutputField> createOutputFields()

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,
             java.util.concurrent.Callable<? extends V> loader)

getPMML

public org.dmg.pmml.PMML getPMML()

getModel

public M getModel()

selectModel

protected static <M extends org.dmg.pmml.Model> M selectModel(org.dmg.pmml.PMML pmml,
                                           java.lang.Class<? extends M> clazz)