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>, HasPMML, 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

Modifier and Type	Method and Description
void	configure(ModelEvaluatorFactory modelEvaluatorFactory) Configures the runtime behaviour of this Evaluator instance.
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 ModelEvaluatorFactory	ensureModelEvaluatorFactory()
protected M	ensureScorableModel()
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.
abstract Map<org.dmg.pmml.FieldName,?>	evaluate(ModelEvaluationContext context)
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(String name)
org.dmg.pmml.DerivedField	getDerivedField(org.dmg.pmml.FieldName name)
List<InputField>	getInputFields()
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()
ModelEvaluatorFactory	getModelEvaluatorFactory()
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()
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name)
TargetField	getTargetField()
org.dmg.pmml.FieldName	getTargetFieldName()
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, Callable<? extends V> loader)
<V> V	getValue(com.google.common.cache.LoadingCache<M,V> cache)
ValueFactory<?>	getValueFactory()
ValueFactoryFactory	getValueFactoryFactory()
boolean	isPrimitive()
protected org.dmg.pmml.DerivedField	resolveDerivedField(org.dmg.pmml.FieldName name)
protected org.dmg.pmml.Field<?>	resolveField(org.dmg.pmml.FieldName name)
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 Map<org.dmg.pmml.FieldName,?> evaluate(ModelEvaluationContext context)

configure

public void configure(ModelEvaluatorFactory modelEvaluatorFactory)

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.

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)

isPrimitive

public boolean isPrimitive()

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()

getTargetFieldName

public org.dmg.pmml.FieldName getTargetFieldName()

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

createMiningSchemaException

protected EvaluationException createMiningSchemaException(String message)

verify

public void verify()

Description copied from interface: Evaluator

Verifies the model.

Specified by:

verify in interface Evaluator

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

resolveField

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

resolveDerivedField

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

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()

ensureScorableModel

protected M ensureScorableModel()

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)

ensureModelEvaluatorFactory

protected ModelEvaluatorFactory ensureModelEvaluatorFactory()

ensureValueFactoryFactory

protected ValueFactoryFactory ensureValueFactoryFactory()

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>

getModelEvaluatorFactory

public ModelEvaluatorFactory getModelEvaluatorFactory()

getValueFactoryFactory

public ValueFactoryFactory getValueFactoryFactory()

getValueFactory

public ValueFactory<?> getValueFactory()