aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPatrick Wendell <pwendell@gmail.com>2014-05-08 22:26:17 -0700
committerPatrick Wendell <pwendell@gmail.com>2014-05-08 22:26:36 -0700
commit06b15baab25951d124bbe6b64906f4139e037deb (patch)
tree5d696f3f36535553478418c850882c0325e38af3 /README.md
parent3f779d872d8459b262b3db9e4d12b011910b6ce9 (diff)
downloadspark-06b15baab25951d124bbe6b64906f4139e037deb.tar.gz
spark-06b15baab25951d124bbe6b64906f4139e037deb.tar.bz2
spark-06b15baab25951d124bbe6b64906f4139e037deb.zip
SPARK-1565 (Addendum): Replace `run-example` with `spark-submit`.
Gives a nicely formatted message to the user when `run-example` is run to tell them to use `spark-submit`. Author: Patrick Wendell <pwendell@gmail.com> Closes #704 from pwendell/examples and squashes the following commits: 1996ee8 [Patrick Wendell] Feedback form Andrew 3eb7803 [Patrick Wendell] Suggestions from TD 2474668 [Patrick Wendell] SPARK-1565 (Addendum): Replace `run-example` with `spark-submit`.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index e2d1dcb567..9c2e32b90f 100644
--- a/README.md
+++ b/README.md
@@ -39,17 +39,22 @@ And run the following command, which should also return 1000:
## 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:
+To run one of them, use `./bin/run-example <class> [params]`. For example:
- ./bin/run-example org.apache.spark.examples.SparkLR local[2]
+ ./bin/run-example org.apache.spark.examples.SparkLR
-will run the Logistic Regression example locally on 2 CPUs.
+will run the Logistic Regression example locally.
-Each of the example programs prints usage help if no params are given.
+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-cluster" or "yarn-client" 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:
-All of the Spark samples take a `<master>` parameter that is the cluster URL
-to connect to. This can be a mesos:// or spark:// URL, or "local" to run
-locally with one thread, or "local[N]" to run locally with N threads.
+ MASTER=spark://host:7077 ./bin/run-example SparkPi
+
+Many of the example programs print usage help if no params are given.
## Running Tests