Apache Spark - A unified analytics engine for large-scale data processing
Go to file
Joseph K. Bradley 5ffd5d3838 [SPARK-14817][ML][MLLIB][DOC] Made DataFrame-based API primary in MLlib guide
## What changes were proposed in this pull request?

Made DataFrame-based API primary
* Spark doc menu bar and other places now link to ml-guide.html, not mllib-guide.html
* mllib-guide.html keeps RDD-specific list of features, with a link at the top redirecting people to ml-guide.html
* ml-guide.html includes a "maintenance mode" announcement about the RDD-based API
  * **Reviewers: please check this carefully**
* (minor) Titles for DF API no longer include "- spark.ml" suffix.  Titles for RDD API have "- RDD-based API" suffix
* Moved migration guide to ml-guide from mllib-guide
  * Also moved past guides from mllib-migration-guides to ml-migration-guides, with a redirect link on mllib-migration-guides
  * **Reviewers**: I did not change any of the content of the migration guides.

Reorganized DataFrame-based guide:
* ml-guide.html mimics the old mllib-guide.html page in terms of content: overview, migration guide, etc.
* Moved Pipeline description into ml-pipeline.html and moved tuning into ml-tuning.html
  * **Reviewers**: I did not change the content of these guides, except some intro text.
* Sidebar remains the same, but with pipeline and tuning sections added

Other:
* ml-classification-regression.html: Moved text about linear methods to new section in page

## How was this patch tested?

Generated docs locally

Author: Joseph K. Bradley <joseph@databricks.com>

Closes #14213 from jkbradley/ml-guide-2.0.
2016-07-15 13:38:23 -07:00
.github [MINOR][MAINTENANCE] Fix typo for the pull request template. 2016-02-24 00:45:31 -08:00
assembly [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
bin [SPARK-16399][PYSPARK] Force PYSPARK_PYTHON to python 2016-07-07 11:31:10 +01:00
build [SPARK-14279][BUILD] Pick the spark version from pom 2016-06-06 09:42:50 -07:00
common [SPARK-16505][YARN] Optionally propagate error during shuffle service startup. 2016-07-14 09:42:32 -05:00
conf [SPARK-15806][DOCUMENTATION] update doc for SPARK_MASTER_IP 2016-06-12 14:25:48 +01:00
core [SPARK-16540][YARN][CORE] Avoid adding jars twice for Spark running on yarn 2016-07-14 10:40:59 -07:00
data [GRAPHX][EXAMPLES] move graphx test data directory and update graphx document 2016-07-02 08:40:23 +01:00
dev [SPARK-15467][BUILD] update janino version to 3.0.0 2016-07-10 17:58:27 -07:00
docs [SPARK-14817][ML][MLLIB][DOC] Made DataFrame-based API primary in MLlib guide 2016-07-15 13:38:23 -07:00
examples [SPARK-16403][EXAMPLES] Cleanup to remove unused imports, consistent style, minor fixes 2016-07-14 09:12:46 +01:00
external [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
graphx [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
launcher [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
licenses [MINOR][BUILD] Add modernizr MIT license; specify "2014 and onwards" in license copyright 2016-06-04 21:41:27 +01:00
mllib [SPARK-16426][MLLIB] Fix bug that caused NaNs in IsotonicRegression 2016-07-15 12:30:22 +01:00
mllib-local [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
project [SPARK-16199][SQL] Add a method to list the referenced columns in data source Filter 2016-07-11 22:23:32 -07:00
python [SPARK-14817][ML][MLLIB][DOC] Made DataFrame-based API primary in MLlib guide 2016-07-15 13:38:23 -07:00
R [SPARK-16538][SPARKR] fix R call with namespace operator on SparkSession functions 2016-07-14 09:45:30 -07:00
repl [SPARK-16540][YARN][CORE] Avoid adding jars twice for Spark running on yarn 2016-07-14 10:40:59 -07:00
sbin [SPARK-15806][DOCUMENTATION] update doc for SPARK_MASTER_IP 2016-06-12 14:25:48 +01:00
sql [SPARK-16557][SQL] Remove stale doc in sql/README.md 2016-07-14 19:24:42 -07:00
streaming [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
tools [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
yarn [SPARK-16505][YARN] Optionally propagate error during shuffle service startup. 2016-07-14 09:42:32 -05:00
.gitattributes [SPARK-3870] EOL character enforcement 2014-10-31 12:39:52 -07:00
.gitignore [SPARK-16128][SQL] Allow setting length of characters to be truncated to, in Dataset.show function. 2016-06-28 17:11:06 +05:30
.travis.yml [SPARK-15207][BUILD] Use Travis CI for Java Linter and JDK7/8 compilation test 2016-05-10 21:04:22 +01:00
CONTRIBUTING.md [SPARK-6889] [DOCS] CONTRIBUTING.md updates to accompany contribution doc updates 2015-04-21 22:34:31 -07:00
LICENSE [MINOR][BUILD] Add modernizr MIT license; specify "2014 and onwards" in license copyright 2016-06-04 21:41:27 +01:00
NOTICE [MINOR][BUILD] Add modernizr MIT license; specify "2014 and onwards" in license copyright 2016-06-04 21:41:27 +01:00
pom.xml [SPARK-16477] Bump master version to 2.1.0-SNAPSHOT 2016-07-11 09:42:56 -07:00
README.md [SPARK-15821][DOCS] Include parallel build info 2016-06-14 13:59:01 +01:00
scalastyle-config.xml [SPARK-16129][CORE][SQL] Eliminate direct use of commons-lang classes in favor of commons-lang3 2016-06-24 10:35:54 +01:00

Apache Spark

Spark is a fast and general cluster computing system for Big Data. It provides high-level APIs in Scala, Java, Python, and R, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and DataFrames, MLlib for machine learning, GraphX for graph processing, and Spark Streaming for stream processing.

http://spark.apache.org/

Online Documentation

You can find the latest Spark documentation, including a programming guide, on the project web page and project wiki. This README file only contains basic setup instructions.

Building Spark

Spark is built using Apache Maven. To build Spark and its example programs, run:

build/mvn -DskipTests clean package

(You do not need to do this if you downloaded a pre-built package.)

You can build Spark using more than one thread by using the -T option with Maven, see "Parallel builds in Maven 3". More detailed documentation is available from the project site, at "Building Spark". For developing Spark using an IDE, see Eclipse and IntelliJ.

Interactive Scala Shell

The easiest way to start using Spark is through the Scala shell:

./bin/spark-shell

Try the following command, which should return 1000:

scala> sc.parallelize(1 to 1000).count()

Interactive Python Shell

Alternatively, if you prefer Python, you can use the Python shell:

./bin/pyspark

And run the following command, which should also return 1000:

>>> sc.parallelize(range(1000)).count()

Example Programs

Spark also comes with several sample programs in the examples directory. To run one of them, use ./bin/run-example <class> [params]. For example:

./bin/run-example SparkPi

will run the Pi example locally.

You can set the MASTER environment variable when running examples to submit examples to a cluster. This can be a mesos:// or spark:// URL, "yarn" to run on YARN, and "local" to run locally with one thread, or "local[N]" to run locally with N threads. You can also use an abbreviated class name if the class is in the examples package. For instance:

MASTER=spark://host:7077 ./bin/run-example SparkPi

Many of the example programs print usage help if no params are given.

Running Tests

Testing first requires building Spark. Once Spark is built, tests can be run using:

./dev/run-tests

Please see the guidance on how to run tests for a module, or individual tests.

A Note About Hadoop Versions

Spark uses the Hadoop core library to talk to HDFS and other Hadoop-supported storage systems. Because the protocols have changed in different versions of Hadoop, you must build Spark against the same version that your cluster runs.

Please refer to the build documentation at "Specifying the Hadoop Version" for detailed guidance on building for a particular distribution of Hadoop, including building for particular Hive and Hive Thriftserver distributions.

Configuration

Please refer to the Configuration Guide in the online documentation for an overview on how to configure Spark.