2013-08-31 17:21:10 -04:00
---
layout: global
2015-02-05 14:12:50 -05:00
title: MLlib
displayTitle: Machine Learning Library (MLlib) Guide
description: MLlib machine learning library overview for Spark SPARK_VERSION_SHORT
2013-08-31 17:21:10 -04:00
---
2014-08-12 20:15:21 -04:00
MLlib is Spark's scalable machine learning library consisting of common learning algorithms and utilities,
2014-04-22 14:20:47 -04:00
including classification, regression, clustering, collaborative
2014-08-12 20:15:21 -04:00
filtering, dimensionality reduction, as well as underlying optimization primitives, as outlined below:
2014-01-03 19:38:33 -05:00
2014-08-27 04:19:48 -04:00
* [Data types ](mllib-data-types.html )
* [Basic statistics ](mllib-statistics.html )
2014-04-22 14:20:47 -04:00
* summary statistics
2014-08-27 04:19:48 -04:00
* correlations
* stratified sampling
2014-08-12 20:15:21 -04:00
* hypothesis testing
2014-08-27 04:19:48 -04:00
* random data generation
2014-08-12 20:15:21 -04:00
* [Classification and regression ](mllib-classification-regression.html )
* [linear models (SVMs, logistic regression, linear regression) ](mllib-linear-methods.html )
2014-04-22 14:20:47 -04:00
* [naive Bayes ](mllib-naive-bayes.html )
2014-12-03 20:57:50 -05:00
* [decision trees ](mllib-decision-tree.html )
* [ensembles of trees ](mllib-ensembles.html ) (Random Forests and Gradient-Boosted Trees)
2015-02-15 12:10:03 -05:00
* [isotonic regression ](mllib-isotonic-regression.html )
2014-04-22 14:20:47 -04:00
* [Collaborative filtering ](mllib-collaborative-filtering.html )
* alternating least squares (ALS)
* [Clustering ](mllib-clustering.html )
2015-02-13 18:09:27 -05:00
* [k-means ](mllib-clustering.html#k-means )
* [Gaussian mixture ](mllib-clustering.html#gaussian-mixture )
* [power iteration clustering (PIC) ](mllib-clustering.html#power-iteration-clustering-pic )
* [latent Dirichlet allocation (LDA) ](mllib-clustering.html#latent-dirichlet-allocation-lda )
* [streaming k-means ](mllib-clustering.html#streaming-k-means )
2014-04-22 14:20:47 -04:00
* [Dimensionality reduction ](mllib-dimensionality-reduction.html )
* singular value decomposition (SVD)
* principal component analysis (PCA)
2014-08-12 20:15:21 -04:00
* [Feature extraction and transformation ](mllib-feature-extraction.html )
2015-02-18 13:09:56 -05:00
* [Frequent pattern mining ](mllib-frequent-pattern-mining.html )
* FP-growth
2014-08-12 20:15:21 -04:00
* [Optimization (developer) ](mllib-optimization.html )
2014-04-22 14:20:47 -04:00
* stochastic gradient descent
* limited-memory BFGS (L-BFGS)
2014-08-12 20:15:21 -04:00
MLlib is under active development.
2014-05-18 20:00:57 -04:00
The APIs marked `Experimental` /`DeveloperApi` may change in future releases,
2014-08-12 20:15:21 -04:00
and the migration guide below will explain all changes between releases.
2014-04-22 14:20:47 -04:00
2015-01-14 20:50:33 -05:00
# spark.ml: high-level APIs for ML pipelines
2014-12-04 04:00:06 -05:00
2015-02-20 05:31:32 -05:00
Spark 1.2 introduced a new package called `spark.ml` , which aims to provide a uniform set of
2015-01-14 20:50:33 -05:00
high-level APIs that help users create and tune practical machine learning pipelines.
It is currently an alpha component, and we would like to hear back from the community about
how it fits real-world use cases and how it could be improved.
2014-12-04 04:00:06 -05:00
2015-01-14 20:50:33 -05:00
Note that we will keep supporting and adding features to `spark.mllib` along with the
development of `spark.ml` .
Users should be comfortable using `spark.mllib` features and expect more features coming.
Developers should contribute new algorithms to `spark.mllib` and can optionally contribute
to `spark.ml` .
2014-12-04 04:00:06 -05:00
2015-01-14 20:50:33 -05:00
See the ** [spark.ml programming guide ](ml-guide.html )** for more information on this package.
2014-12-04 04:00:06 -05:00
[SPARK-1566] consolidate programming guide, and general doc updates
This is a fairly large PR to clean up and update the docs for 1.0. The major changes are:
* A unified programming guide for all languages replaces language-specific ones and shows language-specific info in tabs
* New programming guide sections on key-value pairs, unit testing, input formats beyond text, migrating from 0.9, and passing functions to Spark
* Spark-submit guide moved to a separate page and expanded slightly
* Various cleanups of the menu system, security docs, and others
* Updated look of title bar to differentiate the docs from previous Spark versions
You can find the updated docs at http://people.apache.org/~matei/1.0-docs/_site/ and in particular http://people.apache.org/~matei/1.0-docs/_site/programming-guide.html.
Author: Matei Zaharia <matei@databricks.com>
Closes #896 from mateiz/1.0-docs and squashes the following commits:
03e6853 [Matei Zaharia] Some tweaks to configuration and YARN docs
0779508 [Matei Zaharia] tweak
ef671d4 [Matei Zaharia] Keep frames in JavaDoc links, and other small tweaks
1bf4112 [Matei Zaharia] Review comments
4414f88 [Matei Zaharia] tweaks
d04e979 [Matei Zaharia] Fix some old links to Java guide
a34ed33 [Matei Zaharia] tweak
541bb3b [Matei Zaharia] miscellaneous changes
fcefdec [Matei Zaharia] Moved submitting apps to separate doc
61d72b4 [Matei Zaharia] stuff
181f217 [Matei Zaharia] migration guide, remove old language guides
e11a0da [Matei Zaharia] Add more API functions
6a030a9 [Matei Zaharia] tweaks
8db0ae3 [Matei Zaharia] Added key-value pairs section
318d2c9 [Matei Zaharia] tweaks
1c81477 [Matei Zaharia] New section on basics and function syntax
e38f559 [Matei Zaharia] Actually added programming guide to Git
a33d6fe [Matei Zaharia] First pass at updating programming guide to support all languages, plus other tweaks throughout
3b6a876 [Matei Zaharia] More CSS tweaks
01ec8bf [Matei Zaharia] More CSS tweaks
e6d252e [Matei Zaharia] Change color of doc title bar to differentiate from 0.9.0
2014-05-30 03:34:33 -04:00
# Dependencies
2014-04-22 14:20:47 -04:00
2015-02-08 19:34:26 -05:00
MLlib uses the linear algebra package
[Breeze ](http://www.scalanlp.org/ ), which depends on
[netlib-java ](https://github.com/fommil/netlib-java ) for optimised
numerical processing. If natives are not available at runtime, you
will see a warning message and a pure JVM implementation will be used
instead.
To learn more about the benefits and background of system optimised
natives, you may wish to watch Sam Halliday's ScalaX talk on
[High Performance Linear Algebra in Scala ](http://fommil.github.io/scalax14/#/ )).
Due to licensing issues with runtime proprietary binaries, we do not
include `netlib-java` 's native proxies by default. To configure
`netlib-java` / Breeze to use system optimised binaries, include
`com.github.fommil.netlib:all:1.1.2` (or build Spark with
`-Pnetlib-lgpl` ) as a dependency of your project and read the
[netlib-java ](https://github.com/fommil/netlib-java ) documentation for
your platform's additional installation instructions.
To use MLlib in Python, you will need [NumPy ](http://www.numpy.org )
version 1.4 or newer.
2014-04-22 14:20:47 -04:00
---
[SPARK-1566] consolidate programming guide, and general doc updates
This is a fairly large PR to clean up and update the docs for 1.0. The major changes are:
* A unified programming guide for all languages replaces language-specific ones and shows language-specific info in tabs
* New programming guide sections on key-value pairs, unit testing, input formats beyond text, migrating from 0.9, and passing functions to Spark
* Spark-submit guide moved to a separate page and expanded slightly
* Various cleanups of the menu system, security docs, and others
* Updated look of title bar to differentiate the docs from previous Spark versions
You can find the updated docs at http://people.apache.org/~matei/1.0-docs/_site/ and in particular http://people.apache.org/~matei/1.0-docs/_site/programming-guide.html.
Author: Matei Zaharia <matei@databricks.com>
Closes #896 from mateiz/1.0-docs and squashes the following commits:
03e6853 [Matei Zaharia] Some tweaks to configuration and YARN docs
0779508 [Matei Zaharia] tweak
ef671d4 [Matei Zaharia] Keep frames in JavaDoc links, and other small tweaks
1bf4112 [Matei Zaharia] Review comments
4414f88 [Matei Zaharia] tweaks
d04e979 [Matei Zaharia] Fix some old links to Java guide
a34ed33 [Matei Zaharia] tweak
541bb3b [Matei Zaharia] miscellaneous changes
fcefdec [Matei Zaharia] Moved submitting apps to separate doc
61d72b4 [Matei Zaharia] stuff
181f217 [Matei Zaharia] migration guide, remove old language guides
e11a0da [Matei Zaharia] Add more API functions
6a030a9 [Matei Zaharia] tweaks
8db0ae3 [Matei Zaharia] Added key-value pairs section
318d2c9 [Matei Zaharia] tweaks
1c81477 [Matei Zaharia] New section on basics and function syntax
e38f559 [Matei Zaharia] Actually added programming guide to Git
a33d6fe [Matei Zaharia] First pass at updating programming guide to support all languages, plus other tweaks throughout
3b6a876 [Matei Zaharia] More CSS tweaks
01ec8bf [Matei Zaharia] More CSS tweaks
e6d252e [Matei Zaharia] Change color of doc title bar to differentiate from 0.9.0
2014-05-30 03:34:33 -04:00
# Migration Guide
2014-04-22 14:20:47 -04:00
2015-02-20 05:31:32 -05:00
For the `spark.ml` package, please see the [spark.ml Migration Guide ](ml-guide.html#migration-guide ).
2014-12-03 20:57:50 -05:00
2015-02-20 05:31:32 -05:00
## From 1.2 to 1.3
2014-12-03 20:57:50 -05:00
2015-02-20 05:31:32 -05:00
In the `spark.mllib` package, there were several breaking changes. The first change (in `ALS` ) is the only one in a component not marked as Alpha or Experimental.
2014-12-03 20:57:50 -05:00
2015-02-20 05:31:32 -05:00
* *(Breaking change)* In [`ALS` ](api/scala/index.html#org.apache.spark.mllib.recommendation.ALS ), the extraneous method `solveLeastSquares` has been removed. The `DeveloperApi` method `analyzeBlocks` was also removed.
* *(Breaking change)* [`StandardScalerModel` ](api/scala/index.html#org.apache.spark.mllib.feature.StandardScalerModel ) remains an Alpha component. In it, the `variance` method has been replaced with the `std` method. To compute the column variance values returned by the original `variance` method, simply square the standard deviation values returned by `std` .
* *(Breaking change)* [`StreamingLinearRegressionWithSGD` ](api/scala/index.html#org.apache.spark.mllib.regression.StreamingLinearRegressionWithSGD ) remains an Experimental component. In it, there were two changes:
* The constructor taking arguments was removed in favor of a builder patten using the default constructor plus parameter setter methods.
* Variable `model` is no longer public.
* *(Breaking change)* [`DecisionTree` ](api/scala/index.html#org.apache.spark.mllib.tree.DecisionTree ) remains an Experimental component. In it and its associated classes, there were several changes:
* In `DecisionTree` , the deprecated class method `train` has been removed. (The object/static `train` methods remain.)
* In `Strategy` , the `checkpointDir` parameter has been removed. Checkpointing is still supported, but the checkpoint directory must be set before calling tree and tree ensemble training.
* `PythonMLlibAPI` (the interface between Scala/Java and Python for MLlib) was a public API but is now private, declared `private[python]` . This was never meant for external use.
2015-03-13 13:27:28 -04:00
* In linear regression (including Lasso and ridge regression), the squared loss is now divided by 2.
So in order to produce the same result as in 1.2, the regularization parameter needs to be divided by 2 and the step size needs to be multiplied by 2.
2014-12-03 20:57:50 -05:00
2015-02-20 05:31:32 -05:00
## Previous Spark Versions
2014-12-03 20:57:50 -05:00
2015-02-20 05:31:32 -05:00
Earlier migration guides are archived [on this page ](mllib-migration-guides.html ).