Apache Spark - A unified analytics engine for large-scale data processing
Go to file
Xin Ren e4675c2402 [SPARK-13018][DOCS] Replace example code in mllib-pmml-model-export.md using include_example
Replace example code in mllib-pmml-model-export.md using include_example
https://issues.apache.org/jira/browse/SPARK-13018

The example code in the user guide is embedded in the markdown and hence it is not easy to test. It would be nice to automatically test them. This JIRA is to discuss options to automate example code testing and see what we can do in Spark 1.6.

Goal is to move actual example code to spark/examples and test compilation in Jenkins builds. Then in the markdown, we can reference part of the code to show in the user guide. This requires adding a Jekyll tag that is similar to https://github.com/jekyll/jekyll/blob/master/lib/jekyll/tags/include.rb, e.g., called include_example.
`{% include_example scala/org/apache/spark/examples/mllib/PMMLModelExportExample.scala %}`
Jekyll will find `examples/src/main/scala/org/apache/spark/examples/mllib/PMMLModelExportExample.scala` and pick code blocks marked "example" and replace code block in
`{% highlight %}`
 in the markdown.

See more sub-tasks in parent ticket: https://issues.apache.org/jira/browse/SPARK-11337

Author: Xin Ren <iamshrek@126.com>

Closes #11126 from keypointt/SPARK-13018.
2016-02-15 20:17:21 -08:00
assembly [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
bin [SPARK-11518][DEPLOY, WINDOWS] Handle spaces in Windows command scripts 2016-02-10 09:54:22 +00:00
build [SPARK-12475][BUILD] Upgrade Zinc from 0.3.5.3 to 0.3.9 2015-12-22 10:23:24 -08:00
common/sketch [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
conf [SPARK-13264][DOC] Removed multi-byte characters in spark-env.sh.template 2016-02-11 09:30:36 +00:00
core [SPARK-13278][CORE] Launcher fails to start with JDK 9 EA 2016-02-14 11:49:37 +00:00
data [SPARK-9057][STREAMING] Twitter example joining to static RDD of word sentiment values 2015-12-18 15:06:54 +00:00
dev [SPARK-13154][PYTHON] Add linting for pydocs 2016-02-12 02:13:06 -08:00
docker [SPARK-13189] Cleanup build references to Scala 2.10 2016-02-09 11:56:25 -08:00
docker-integration-tests [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
docs [SPARK-13018][DOCS] Replace example code in mllib-pmml-model-export.md using include_example 2016-02-15 20:17:21 -08:00
examples [SPARK-13018][DOCS] Replace example code in mllib-pmml-model-export.md using include_example 2016-02-15 20:17:21 -08:00
external [SPARK-13165][STREAMING] Replace deprecated synchronizedBuffer in streaming 2016-02-09 08:44:56 +00:00
extras [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
graphx [SPARK-12995][GRAPHX] Remove deprecate APIs from Pregel 2016-02-15 09:20:49 +00:00
launcher [SPARK-13278][CORE] Launcher fails to start with JDK 9 EA 2016-02-14 11:49:37 +00:00
licenses [SPARK-10833] [BUILD] Inline, organize BSD/MIT licenses in LICENSE 2015-09-28 22:56:43 -04:00
mllib [SPARK-13097][ML] Binarizer allowing Double AND Vector input types 2016-02-15 20:15:27 -08:00
network [SPARK-12807][YARN] Spark External Shuffle not working in Hadoop clusters with Jackson 2.2.3 2016-02-09 11:01:47 -08:00
project [SPARK-12995][GRAPHX] Remove deprecate APIs from Pregel 2016-02-15 09:20:49 +00:00
python [SPARK-13296][SQL] Move UserDefinedFunction into sql.expressions. 2016-02-13 21:06:31 -08:00
R [SPARK-13264][DOC] Removed multi-byte characters in spark-env.sh.template 2016-02-11 09:30:36 +00:00
repl [SPARK-13086][SHELL] Use the Scala REPL settings, to enable things like -i file. 2016-02-09 09:05:22 +00:00
sbin [SPARK-12652][PYSPARK] Upgrade Py4J to 0.9.1 2016-01-12 14:27:05 -08:00
sbt Adde LICENSE Header to build/mvn, build/sbt and sbt/sbt 2014-12-29 10:48:53 -08:00
sql [SPARK-12503][SPARK-12505] Limit pushdown in UNION ALL and OUTER JOIN 2016-02-14 17:32:21 -08:00
streaming [SPARK-13172][CORE][SQL] Stop using RichException.getStackTrace it is deprecated 2016-02-13 21:05:48 -08:00
tags [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
tools [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
unsafe [SPARK-13043][SQL] Implement remaining catalyst types in ColumnarBatch. 2016-02-01 13:56:14 -08:00
yarn [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
.gitattributes [SPARK-3870] EOL character enforcement 2014-10-31 12:39:52 -07:00
.gitignore [SPARK-12735] Consolidate & move spark-ec2 to AMPLab managed repository. 2016-01-09 20:28:20 -08:00
.rat-excludes [SPARK-12790][CORE] Remove HistoryServer old multiple files format 2016-02-01 16:55:21 -08:00
checkstyle-suppressions.xml [SPARK-6990][BUILD] Add Java linting script; fix minor warnings 2015-12-04 12:03:45 -08:00
checkstyle.xml [SPARK-12830] Java style: disallow trailing whitespaces. 2016-01-14 23:33:45 -08:00
CONTRIBUTING.md [SPARK-6889] [DOCS] CONTRIBUTING.md updates to accompany contribution doc updates 2015-04-21 22:34:31 -07:00
LICENSE [SPARK-13189] Cleanup build references to Scala 2.10 2016-02-09 11:56:25 -08:00
make-distribution.sh [SPARK-12735] Consolidate & move spark-ec2 to AMPLab managed repository. 2016-01-09 20:28:20 -08:00
NOTICE [SPARK-8725][PROJECT-INFRA] Test modules in topologically-sorted order in dev/run-tests 2016-01-26 14:20:11 -08:00
pom.xml [SPARK-13189] Cleanup build references to Scala 2.10 2016-02-09 11:56:25 -08:00
pylintrc [SPARK-9116] [SQL] [PYSPARK] support Python only UDT in __main__ 2015-07-29 22:30:49 -07:00
README.md Add links howto to setup IDEs for developing spark 2015-12-04 14:43:16 +00:00
scalastyle-config.xml [SPARK-13203] Add scalastyle rule banning use of mutable.SynchronizedBuffer 2016-02-10 10:58:41 +00:00
tox.ini [SPARK-7427] [PYSPARK] Make sharedParams match in Scala, Python 2015-05-10 19:18:32 -07: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.) 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.