Apache Spark - A unified analytics engine for large-scale data processing
Go to file
Dongjoon Hyun 4a6e78abd9 [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code.
## What changes were proposed in this pull request?

This PR aims to fix all Scala-Style multiline comments into Java-Style multiline comments in Scala codes.
(All comment-only changes over 77 files: +786 lines, −747 lines)

## How was this patch tested?

Manual.

Author: Dongjoon Hyun <dongjoon@apache.org>

Closes #12130 from dongjoon-hyun/use_multiine_javadoc_comments.
2016-04-02 17:50:40 -07:00
.github [MINOR][MAINTENANCE] Fix typo for the pull request template. 2016-02-24 00:45:31 -08:00
assembly [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
bin [SPARK-13973][PYSPARK] ipython notebook` is going away 2016-03-26 12:53:37 +00:00
build [SPARK-13324][CORE][BUILD] Update plugin, test, example dependencies for 2.x 2016-02-17 19:03:29 -08:00
common [SPARK-13992] Add support for off-heap caching 2016-04-01 14:34:59 -07:00
conf [SPARK-13264][DOC] Removed multi-byte characters in spark-env.sh.template 2016-02-11 09:30:36 +00:00
core [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
data [SPARK-13013][DOCS] Replace example code in mllib-clustering.md using include_example 2016-03-03 09:32:47 -08:00
dev [SPARK-13825][CORE] Upgrade to Scala 2.11.8 2016-04-01 15:21:29 -07:00
docs [SPARK-12343][YARN] Simplify Yarn client and client argument 2016-04-01 10:52:13 -07:00
examples [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
external [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
graphx [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
launcher [SPARK-13955][YARN] Also look for Spark jars in the build directory. 2016-03-30 13:59:10 -07:00
licenses [SPARK-13874][DOC] Remove docs of streaming-akka, streaming-zeromq, streaming-mqtt and streaming-twitter 2016-03-26 01:47:27 -07:00
mllib [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
project [SPARK-13674] [SQL] Add wholestage codegen support to Sample 2016-04-01 14:02:32 -07:00
python [SPARK-14305][ML][PYSPARK] PySpark ml.clustering BisectingKMeans support export/import 2016-04-01 12:53:39 -07:00
R [SPARK-14303][ML][SPARKR] Define and use KMeansWrapper for SparkR::kmeans 2016-03-31 23:49:58 -07:00
repl [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
sbin [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
sql [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
streaming [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
tools [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
yarn [MINOR][DOCS] Use multi-line JavaDoc comments in Scala code. 2016-04-02 17:50:40 -07:00
.gitattributes [SPARK-3870] EOL character enforcement 2014-10-31 12:39:52 -07:00
.gitignore [SPARK-13596][BUILD] Move misc top-level build files into appropriate subdirs 2016-03-07 14:48:02 -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-13713][SQL] Migrate parser from ANTLR3 to ANTLR4 2016-03-28 12:31:12 -07:00
NOTICE [SPARK-13874][DOC] Remove docs of streaming-akka, streaming-zeromq, streaming-mqtt and streaming-twitter 2016-03-26 01:47:27 -07:00
pom.xml [SPARK-13825][CORE] Upgrade to Scala 2.11.8 2016-04-01 15:21:29 -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-3854][BUILD] Scala style: require spaces before {. 2016-03-10 15:57:22 -08: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.