JPMML-Evaluator
Java Evaluator API for Predictive Model Markup Language (PMML).
Table of Contents
Features
JPMML-Evaluator is de facto the reference implementation of the PMML specification versions 3.0, 3.1, 3.2, 4.0, 4.1, 4.2 and 4.3 for the Java/JVM platform:
Pre-processing of input fields according to the DataDictionary and MiningSchema elements:
Complete data type system.
Complete operational type system.
Treatment of outlier, missing and/or invalid values.
Post-processing of target fields according to the Targets element:
Rescaling and/or casting regression results.
Replacing a missing regression result with the default value.
Replacing a missing classification result with the map of prior probabilities.
Calculation of auxiliary output fields according to the Output element:
Over 20 different result feature types.
Model verification according to the ModelVerification element.
Vendor extensions:
Memory and security sandboxing.
Java-backed model, expression and predicate types - integrate any 3rd party Java library into PMML data flow.
MathML prediction reports.
For more information please see the features.md file.
JPMML-Evaluator is interoperable with most popular statistics and data mining software:
JPMML-Evaluator is fast and memory efficient. It can deliver one million scorings per second already on a desktop computer.
Prerequisites
Java Platform, Standard Edition 8 or newer.
Installation
JPMML-Evaluator library JAR files (together with accompanying Java source and Javadocs JAR files) are released via Maven Central Repository.
The current version is 1.4.14 (2 December, 2019).
org.jpmml
pmml-evaluator
1.4.14
org.jpmml
pmml-evaluator-extension
1.4.14
API
Core types:
Interface org.jpmml.evaluator.EvaluatorBuilder
Class org.jpmml.evaluator.ModelEvaluatorBuilder - Builds a ModelEvaluator instance based on an org.dmg.pmml.PMML instance
Class org.jpmml.evaluator.LoadingModelEvaluatorBuilder - Builds a ModelEvaluator instance from a PMML byte stream or a PMML file
Class org.jpmml.evaluator.ServiceLoadingModelEvaluatorBuilder - Builds a ModelEvaluator instance from a PMML service provider JAR file
Interface org.jpmml.evaluator.Evaluator
Abstract class org.jpmml.evaluator.ModelEvaluator - Implements model evaluator functionality based on an org.dmg.pmml.Model instance
Classes org.jpmml.evaluator.Evaluator (GeneralRegressionModelEvaluator, MiningModelEvaluator, NeuralNetworkEvaluator, RegressionEvaluator, TreeModelEvaluator, SupportVectorMachineEvaluator etc.)
Abstract class org.jpmml.evaluator.ModelField
Abstract class org.jpmml.evaluator.InputField - Describes a model input field
Abstract class org.jpmml.evaluator.ResultField
Class org.jpmml.evaluator.TargetField - Describes a primary model result field
Class org.jpmml.evaluator.OutputField - Describes a secondary model result field
Abstract class org.jpmml.evaluator.FieldValue
Class org.jpmml.evaluator.CollectionValue
Abstract class org.jpmml.evaluator.ScalarValue
Class org.jpmml.evaluator.ContinuousValue
Abstract class org.jpmml.evaluator.DiscreteValue
Class org.jpmml.evaluator.CategoricalValue
Class org.jpmml.evaluator.OrdinalValue
Utility class org.jpmml.evaluator.EvaluatorUtil
Utility class org.jpmml.evaluator.FieldValueUtil
Core methods:
EvaluatorBuilder
#build()
Evaluator
#verify()
#getInputFields()
#getTargetFields()
#getOutputFields()
#evaluate(Map)
InputField</