Merge branch 'master' of https://github.com/leferrad/learninspy

README.md

@@ -10,7 +10,7 @@ Learninspy
 [![Coverage Status](https://coveralls.io/repos/github/leferrad/learninspy/badge.svg?branch=master)](https://coveralls.io/github/leferrad/learninspy?branch=master)
 [![Code Health](https://landscape.io/github/leferrad/learninspy/master/landscape.svg?style=flat)](https://landscape.io/github/leferrad/learninspy/master)
 
-### Welcome to learninspy!
+### Welcome to Learninspy!
 Learninspy is a framework for building deep neural networks using Spark features on Python API (PySpark). The project was started in April 2015 by Leandro Ferrado, and it aims to exploit distributed computing capabilities provided by Spark to build and train neural networks with Deep Learning in a simple and flexible way. So, the key features pursued here are:
 * **Simple and easy-to-follow:** That's why Python was chosen as the basis for developing on Spark, so this project must be easy to reuse in any application of deep learning.  
 * **Extensible:** It has many degrees of freedom on its feature definitions (e.g. activation functions, optimization algorithms and stop criterions, hyper-parameters setup, etc) and of course in a simple way!.
@@ -22,6 +22,8 @@ Learninspy is a framework for building deep neural networks using Spark features
 * NumPy
 * Matplotlib 
 
+**NOTE:** it is needed to have defined an environment variable called ``SPARK_HOME`` pointing to the Spark's root directory (e.g. /usr/local/spark/). In addition, if you want to connect Learninspy with a Spark's standalone cluster, you need to define the following environment variables: ``SPARK_MASTER_IP`` to specify the master's IP address, and ``SPARK_MASTER_PORT`` for its application port.
+
 ## Testing
 Run ``nosetests test/`` from the download directory.