spark-instrumented-optimizer/docs/mllib-pmml-model-export.md
Xin Ren 27cdde2ff8 [SPARK-10669] [DOCS] Link to each language's API in codetabs in ML docs: spark.mllib
In the Markdown docs for the spark.mllib Programming Guide, we have code examples with codetabs for each language. We should link to each language's API docs within the corresponding codetab, but we are inconsistent about this. For an example of what we want to do, see the "ChiSqSelector" section in 64743870f2/docs/mllib-feature-extraction.md
This JIRA is just for spark.mllib, not spark.ml.

Please let me know if more work is needed, thanks a lot.

Author: Xin Ren <iamshrek@126.com>

Closes #8977 from keypointt/SPARK-10669.
2015-10-07 15:00:19 +01:00

2.8 KiB

layout title displayTitle
global PMML model export - MLlib <a href="mllib-guide.html">MLlib</a> - PMML model export
  • Table of contents {:toc}

MLlib supported models

MLlib supports model export to Predictive Model Markup Language (PMML).

The table below outlines the MLlib models that can be exported to PMML and their equivalent PMML model.

MLlib modelPMML model
KMeansModelClusteringModel
LinearRegressionModelRegressionModel (functionName="regression")
RidgeRegressionModelRegressionModel (functionName="regression")
LassoModelRegressionModel (functionName="regression")
SVMModelRegressionModel (functionName="classification" normalizationMethod="none")
Binary LogisticRegressionModelRegressionModel (functionName="classification" normalizationMethod="logit")

Examples

To export a supported `model` (see table above) to PMML, simply call `model.toPMML`.

Refer to the KMeans Scala docs and Vectors Scala docs for details on the API.

Here a complete example of building a KMeansModel and print it out in PMML format: {% highlight scala %} import org.apache.spark.mllib.clustering.KMeans import org.apache.spark.mllib.linalg.Vectors

// Load and parse the data val data = sc.textFile("data/mllib/kmeans_data.txt") val parsedData = data.map(s => Vectors.dense(s.split(' ').map(_.toDouble))).cache()

// Cluster the data into two classes using KMeans val numClusters = 2 val numIterations = 20 val clusters = KMeans.train(parsedData, numClusters, numIterations)

// Export to PMML println("PMML Model:\n" + clusters.toPMML) {% endhighlight %}

As well as exporting the PMML model to a String (model.toPMML as in the example above), you can export the PMML model to other formats:

{% highlight scala %} // Export the model to a String in PMML format clusters.toPMML

// Export the model to a local file in PMML format clusters.toPMML("/tmp/kmeans.xml")

// Export the model to a directory on a distributed file system in PMML format clusters.toPMML(sc,"/tmp/kmeans")

// Export the model to the OutputStream in PMML format clusters.toPMML(System.out) {% endhighlight %}

For unsupported models, either you will not find a .toPMML method or an IllegalArgumentException will be thrown.