Mirror of Apache Spark
Scala Java Python R Shell JavaScript Other
Latest commit cc00e99 Jul 22, 2017 @holdenk holdenk [SPARK-21434][PYTHON][DOCS] Add pyspark pip documentation.
## What changes were proposed in this pull request?

Update the Quickstart and RDD programming guides to mention pip.

## How was this patch tested?

Built docs locally.

Author: Holden Karau <holden@us.ibm.com>

Closes #18698 from holdenk/SPARK-21434-add-pyspark-pip-documentation.
Permalink
Failed to load latest commit information.
.github [SPARK-18073][DOCS][WIP] Migrate wiki to spark.apache.org web site Nov 23, 2016
R [SPARK-20307][ML][SPARKR][FOLLOW-UP] RFormula should handle invalid f… Jul 15, 2017
assembly [SPARK-7481][BUILD] Add spark-hadoop-cloud module to pull in object s… May 7, 2017
bin [SPARK-19810][BUILD][CORE] Remove support for Scala 2.10 Jul 13, 2017
build [SPARK-19810][BUILD][CORE] Remove support for Scala 2.10 Jul 13, 2017
common [SPARK-21445] Make IntWrapper and LongWrapper in UTF8String Serializable Jul 18, 2017
conf [SPARK-21305][ML][MLLIB] Add options to disable multi-threading of na… Jul 12, 2017
core [SPARK-10063] Follow-up: remove dead code related to an old output co… Jul 20, 2017
data [SPARK-16421][EXAMPLES][ML] Improve ML Example Outputs Aug 5, 2016
dev [SPARK-15526][ML][FOLLOWUP] Make JPMML provided scope to avoid includ… Jul 18, 2017
docs [SPARK-21434][PYTHON][DOCS] Add pyspark pip documentation. Jul 21, 2017
examples [SPARK-21415] Triage scapegoat warnings, part 1 Jul 18, 2017
external [SPARK-21142][SS] spark-streaming-kafka-0-10 should depend on kafka-c… Jul 20, 2017
graphx [SPARK-21415] Triage scapegoat warnings, part 1 Jul 18, 2017
hadoop-cloud [SPARK-7481][BUILD] Add spark-hadoop-cloud module to pull in object s… May 7, 2017
launcher [SPARK-15526][ML][FOLLOWUP] Make JPMML provided scope to avoid includ… Jul 18, 2017
licenses [MINOR][BUILD] Add modernizr MIT license; specify "2014 and onwards" … Jun 4, 2016
mllib-local [SPARK-19810][BUILD][CORE] Remove support for Scala 2.10 Jul 13, 2017
mllib [MINOR][ML] Reorg RFormula params. Jul 20, 2017
project [SPARK-21415] Triage scapegoat warnings, part 1 Jul 18, 2017
python [MINOR][DOCS] Fix some missing notes for Python 2.6 support drop Jul 20, 2017
repl [SPARK-19810][BUILD][CORE] Remove support for Scala 2.10 Jul 13, 2017
resource-managers [SPARK-21456][MESOS] Make the driver failover_timeout configurable Jul 19, 2017
sbin [SPARK-21278][PYSPARK] Upgrade to Py4J 0.10.6 Jul 5, 2017
sql [SPARK-21472][SQL][FOLLOW-UP] Introduce ArrowColumnVector as a reader… Jul 21, 2017
streaming [SPARK-21415] Triage scapegoat warnings, part 1 Jul 18, 2017
tools [SPARK-20453] Bump master branch version to 2.3.0-SNAPSHOT Apr 25, 2017
.gitattributes [SPARK-3870] EOL character enforcement Oct 31, 2014
.gitignore [MINOR][SPARKR] ignore Rplots.pdf test output after running R tests Jul 4, 2017
.travis.yml [SPARK-19801][BUILD] Remove JDK7 from Travis CI Mar 3, 2017
CONTRIBUTING.md [SPARK-18073][DOCS][WIP] Migrate wiki to spark.apache.org web site Nov 23, 2016
LICENSE [SPARK-21278][PYSPARK] Upgrade to Py4J 0.10.6 Jul 5, 2017
NOTICE [SPARK-18262][BUILD][SQL] JSON.org license is now CatX Nov 10, 2016
README.md [MINOR][DOCS] Replace non-breaking space to normal spaces that breaks… Apr 3, 2017
appveyor.yml [MINOR][R] Add knitr and rmarkdown packages/improve output for versio… Jun 18, 2017
pom.xml [SPARK-19810][BUILD][FOLLOW-UP] jcl-over-slf4j dependency needs to be… Jul 21, 2017
scalastyle-config.xml [SPARK-13747][CORE] Add ThreadUtils.awaitReady and disallow Await.ready May 18, 2017

README.md

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. 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 general development tips, including info on developing Spark using an IDE, see "Useful Developer Tools".

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.

Contributing

Please review the Contribution to Spark guide for information on how to get started contributing to the project.