diff options
author | Diana Carroll <dcarroll@cloudera.com> | 2014-03-17 17:35:51 -0700 |
---|---|---|
committer | Matei Zaharia <matei@databricks.com> | 2014-03-17 17:35:51 -0700 |
commit | 087eedca32fd87bfe1629588091bd307d45e4a7c (patch) | |
tree | 3f4d2157e646add6130b69161ee16c94b41c38f1 | |
parent | 796977acdb5c96ca5c08591657137fb3e44d2e94 (diff) | |
download | spark-087eedca32fd87bfe1629588091bd307d45e4a7c.tar.gz spark-087eedca32fd87bfe1629588091bd307d45e4a7c.tar.bz2 spark-087eedca32fd87bfe1629588091bd307d45e4a7c.zip |
[Spark-1261] add instructions for running python examples to doc overview page
Author: Diana Carroll <dcarroll@cloudera.com>
Closes #162 from dianacarroll/SPARK-1261 and squashes the following commits:
14ac602 [Diana Carroll] typo in python example text
5121e3e [Diana Carroll] Add explanation of how to run Python examples to main doc overview page
-rw-r--r-- | docs/index.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/index.md b/docs/index.md index c4f4d79edb..23311101e1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,10 +23,12 @@ For its Scala API, Spark {{site.SPARK_VERSION}} depends on Scala {{site.SCALA_BI # Running the Examples and Shell -Spark comes with several sample programs in the `examples` directory. -To run one of the samples, use `./bin/run-example <class> <params>` in the top-level Spark directory +Spark comes with several sample programs. Scala and Java examples are in the `examples` directory, and Python examples are in `python/examples`. +To run one of the Java or Scala sample programs, use `./bin/run-example <class> <params>` in the top-level Spark directory (the `bin/run-example` script sets up the appropriate paths and launches that program). For example, try `./bin/run-example org.apache.spark.examples.SparkPi local`. +To run a Python sample program, use `./bin/pyspark <sample-program> <params>`. For example, try `./bin/pyspark ./python/examples/pi.py local`. + Each example prints usage help when run with no parameters. Note that all of the sample programs take a `<master>` parameter specifying the cluster URL |