Package org.jpmml.evaluator.mining

Class MiningModelEvaluator

java.lang.Object

org.jpmml.evaluator.PMMLManager

org.jpmml.evaluator.ModelManager<M>

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

org.jpmml.evaluator.mining.MiningModelEvaluator

All Implemented Interfaces:

java.io.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	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	Description
void	configure(Configuration configuration)	Configures the runtime behaviour of this model evaluator.
ModelEvaluationContext	createEvaluationContext()
protected java.util.List<OutputField>	createOutputFields()
protected <V extends java.lang.Number> SegmentationResult	evaluateAssociationRules(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends java.lang.Number> SegmentationResult	evaluateClassification(ValueFactory<V> valueFactory, EvaluationContext context)
protected <V extends java.lang.Number> SegmentationResult	evaluateClustering(ValueFactory<V> valueFactory, EvaluationContext context)
SegmentationResult	evaluateInternal(ModelEvaluationContext context)
protected <V extends java.lang.Number> SegmentationResult	evaluateMixed(ValueFactory<V> valueFactory, EvaluationContext context)
protected SegmentationResult	evaluateOutput(java.util.Map<java.lang.String,?> predictions, ModelEvaluationContext context)
protected <V extends java.lang.Number> SegmentationResult	evaluateRegression(ValueFactory<V> valueFactory, EvaluationContext context)
DefaultDataField	getDefaultDataField()
com.google.common.collect.BiMap<java.lang.String,org.dmg.pmml.mining.Segment>	getEntityRegistry()
protected int	getNumberOfVisibleFields()
protected java.util.Set<org.dmg.pmml.ResultFeature>	getSegmentResultFeatures(java.lang.String segmentId)
java.lang.String	getSummary()	Gets a short description of the Model.
java.lang.String	getTargetName()
boolean	isPure()	Indicates if this model evaluator represents a pure function.
protected SegmentationResult	processResults(java.util.Map<java.lang.String,?> results)

Methods inherited from class org.jpmml.evaluator.ModelEvaluator

assessParentCompatibility, assessPurity, createClassification, ensureConfiguration, ensureModelEvaluatorFactory, ensureOutputFilter, ensureValueFactory, ensureValueFactoryFactory, evaluate, evaluateSequences, evaluateTimeSeries, filterInputFields, filterOutputFields, filterTargetFields, getConfiguration, getInputMapper, getResultMapper, isParentCompatible, processArguments, verify

Methods inherited from class org.jpmml.evaluator.ModelManager

addResultFeatures, collectResultFeatures, collectSegmentResultFeatures, createInputFields, createInputFields, createMiningSchemaException, createTargetFields, getActiveFields, getDataField, getInputFields, getLocalDerivedField, getMathContext, getMiningField, getMiningFunction, getModel, getOutputField, getOutputFields, getResultFeatures, getTarget, getTargetField, getTargetFields, 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

Methods inherited from interface org.jpmml.evaluator.HasActiveFields

getActiveFields

Methods inherited from interface org.jpmml.evaluator.HasInputFields

getInputFields

Methods inherited from interface org.jpmml.evaluator.HasPMML

getPMML

Methods inherited from interface org.jpmml.evaluator.HasResultFields

getOutputFields, getTargetFields

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

getSegmentResultFeatures

protected java.util.Set<org.dmg.pmml.ResultFeature> getSegmentResultFeatures(java.lang.String segmentId)

configure

public void configure(Configuration configuration)

Description copied from class: ModelEvaluator

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.

Overrides:

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

getSummary

public java.lang.String getSummary()

Description copied from interface: Evaluator

Gets a short description of the Model.

Specified by:

getSummary in interface Evaluator

getDefaultDataField

public DefaultDataField getDefaultDataField()

Overrides:

getDefaultDataField in class ModelManager<org.dmg.pmml.mining.MiningModel>

Returns:

A synthetic DataField element describing the default target field.

isPure

public boolean isPure()

Description copied from class: ModelEvaluator

Indicates if this model evaluator represents a pure function.

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

Overrides:

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

getTargetName

public java.lang.String getTargetName()

Overrides:

getTargetName in class ModelManager<org.dmg.pmml.mining.MiningModel>

getEntityRegistry

public com.google.common.collect.BiMap<java.lang.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 java.util.List<OutputField> createOutputFields()

Overrides:

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

getNumberOfVisibleFields

protected int getNumberOfVisibleFields()

Overrides:

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

createEvaluationContext

public ModelEvaluationContext createEvaluationContext()

Overrides:

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

evaluateInternal

public SegmentationResult evaluateInternal(ModelEvaluationContext context)

Overrides:

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

evaluateRegression

protected <V extends java.lang.Number> SegmentationResult evaluateRegression(ValueFactory<V> valueFactory,
                                                                             EvaluationContext context)

Overrides:

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

evaluateClassification

protected <V extends java.lang.Number> SegmentationResult evaluateClassification(ValueFactory<V> valueFactory,
                                                                                 EvaluationContext context)

Overrides:

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

evaluateClustering

protected <V extends java.lang.Number> SegmentationResult evaluateClustering(ValueFactory<V> valueFactory,
                                                                             EvaluationContext context)

Overrides:

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

evaluateAssociationRules

protected <V extends java.lang.Number> SegmentationResult evaluateAssociationRules(ValueFactory<V> valueFactory,
                                                                                   EvaluationContext context)

Overrides:

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

evaluateMixed

protected <V extends java.lang.Number> SegmentationResult evaluateMixed(ValueFactory<V> valueFactory,
                                                                        EvaluationContext context)

Overrides:

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

evaluateOutput

protected SegmentationResult evaluateOutput(java.util.Map<java.lang.String,?> predictions,
                                            ModelEvaluationContext context)

Overrides:

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

processResults

protected SegmentationResult processResults(java.util.Map<java.lang.String,?> results)

Overrides:

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