org.jpmml.evaluator

Class NeuralNetworkEvaluator

java.lang.Object

org.jpmml.manager.PMMLManager

org.jpmml.manager.ModelManager<NeuralNetwork>

org.jpmml.manager.NeuralNetworkManager

org.jpmml.evaluator.NeuralNetworkEvaluator

All Implemented Interfaces:

Evaluator, Consumer

public class NeuralNetworkEvaluator
extends NeuralNetworkManager
implements Evaluator

Constructor Summary

Constructors

Constructor and Description
NeuralNetworkEvaluator(NeuralNetworkManager parent)
NeuralNetworkEvaluator(PMML pmml)
NeuralNetworkEvaluator(PMML pmml, NeuralNetwork neuralNetwork)

Method Summary

Methods

Modifier and Type	Method and Description
Map<FieldName,?>	evaluate(Map<FieldName,?> parameters)
Map<FieldName,org.jpmml.evaluator.ClassificationMap>	evaluateClassification(EvaluationContext context)
Map<String,Double>	evaluateRaw(EvaluationContext context) Evaluates neural network.
Map<FieldName,Double>	evaluateRegression(EvaluationContext context)
Object	prepare(FieldName name, Object value) Prepares the input value for a field.

Methods inherited from class org.jpmml.manager.NeuralNetworkManager

addConnection, addConnection, addNeuralInput, addNeuralLayer, addNeuralOutput, addNeuron, createModel, getModel, getNeuralInputs, getNeuralLayers, getNeuronCount, getOrCreateNeuralOutputs, getSummary

Methods inherited from class org.jpmml.manager.ModelManager

addField, addMiningField, ensureNotNull, ensureNull, getActiveFields, getMiningField, getMiningFields, getMiningSchema, getOrCreateLocalTransformations, getOrCreateOutput, getOutputField, getOutputFields, getPredictedFields, getTarget, resolve

Methods inherited from class org.jpmml.manager.PMMLManager

addDataField, find, find, findAll, getDataDictionary, getDataField, getHeader, getModel, getModelManager, getModelManager, getModels, getOrCreateTransformationDictionary, getPmml

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

getTarget

Methods inherited from interface org.jpmml.manager.Consumer

getActiveFields, getDataField, getMiningField, getOutputField, getOutputFields, getPredictedFields, getSummary

Constructor Detail

NeuralNetworkEvaluator

public NeuralNetworkEvaluator(PMML pmml)

NeuralNetworkEvaluator

public NeuralNetworkEvaluator(PMML pmml,
                      NeuralNetwork neuralNetwork)

NeuralNetworkEvaluator

public NeuralNetworkEvaluator(NeuralNetworkManager parent)

Method Detail

prepare

public Object prepare(FieldName name,
             Object value)

Description copied from interface: Evaluator

Prepares the input value for a field. First, the value is converted from the user-supplied representation to internal representation. Later on, the value is subjected to missing value treatment, invalid value treatment and outlier treatment.

Specified by:

prepare in interface Evaluator

Parameters:

name - The name of the field

See Also:

Consumer.getDataField(FieldName), Consumer.getMiningField(FieldName)

evaluate

public Map<FieldName,?> evaluate(Map<FieldName,?> parameters)

Specified by:

evaluate in interface Evaluator

Parameters:

parameters - Map of active field values.

Returns:

Map of predicted field and output field values. Simple values are represented using the Java equivalents of PMML data types (eg. String, Integer, Float, Double etc.). Complex values are represented as instances of Computable that return simple values.

See Also:

evaluateRegression(EvaluationContext), evaluateClassification(EvaluationContext)

evaluateRegression

public Map<FieldName,Double> evaluateRegression(EvaluationContext context)

evaluateClassification

public Map<FieldName,org.jpmml.evaluator.ClassificationMap> evaluateClassification(EvaluationContext context)

evaluateRaw

public Map<String,Double> evaluateRaw(EvaluationContext context)

Evaluates neural network.

Returns:

Mapping between Neuron identifiers and their outputs

See Also:

NeuralInput.getId(), Neuron.getId()