(nojira) Pulling newer readme into this branch
Project: http://git-wip-us.apache.org/repos/asf/mahout/repo Commit: http://git-wip-us.apache.org/repos/asf/mahout/commit/00a09dc7 Tree: http://git-wip-us.apache.org/repos/asf/mahout/tree/00a09dc7 Diff: http://git-wip-us.apache.org/repos/asf/mahout/diff/00a09dc7 Branch: refs/heads/master Commit: 00a09dc7243bddf89d5dd22888397c94f4b7ca77 Parents: 2edb274 Author: Andrew Musselman <[email protected]> Authored: Fri Apr 8 17:10:01 2016 -0700 Committer: Andrew Musselman <[email protected]> Committed: Fri Apr 8 17:10:01 2016 -0700 ---------------------------------------------------------------------- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 22 ---------------------- 2 files changed, 56 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mahout/blob/00a09dc7/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5f6cb5 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +Welcome to Apache Mahout! +=========== +The Apache Mahout⢠project's goal is to build an environment for quickly creating scalable performant machine learning applications. + +For additional information about Mahout, visit the [Mahout Home Page](http://mahout.apache.org/) + +####Setting up your Environment +Whether you are using Mahout's Shell, running command line jobs or using it as a library to build your own apps you'll need to setup several environment variables. Edit your environment in `~/.bash_profile` for Mac or `~/.bashrc` for many linux distributions. Add the following +``` +export MAHOUT_HOME=/path/to/mahout +export MAHOUT_LOCAL=true # for running standalone on your dev machine, +# unset MAHOUT_LOCAL for running on a cluster +``` +You will need a `$JAVA_HOME`, and if you are running on Spark, you will also need `$SPARK_HOME` + +Note when running the spark-shell job it can help to set some JVM options so you don't run out of memory: +``` +$MAHOUT_OPTS="-Xmx6g -XX:MaxPermSize=512m" mahout spark-shell +``` + +####Using Mahout as a Library +Running any application that uses Mahout will require installing a binary or source version and setting the environment. +To compile from source: +* `mvn -DskipTests clean install` +* To run tests do `mvn test` +* To set up your IDE, do `mvn eclipse:eclipse` or `mvn idea:idea` + +To use maven, add the appropriate setting to your pom.xml or build.sbt following the template below. + + +To use the Samsara environment you'll need to include both the engine neutral math-scala dependency: +``` +<dependency> + <groupId>org.apache.mahout</groupId> + <artifactId>mahout-math-scala_2.10</artifactId> + <version>${mahout.version}</version> +</dependency> +``` +and a dependency for back end engine translation, e.g: +``` +<dependency> + <groupId>org.apache.mahout</groupId> + <artifactId>mahout-spark_2.10</artifactId> + <version>${mahout.version}</version> +</dependency> +``` + +####Examples +For examples of how to use Mahout, see the examples directory located in `examples/bin` + + +For information on how to contribute, visit the [How to Contribute Page](https://mahout.apache.org/developers/how-to-contribute.html) + + +####Legal +Please see the `NOTICE.txt` included in this directory for more information. http://git-wip-us.apache.org/repos/asf/mahout/blob/00a09dc7/README.txt ---------------------------------------------------------------------- diff --git a/README.txt b/README.txt deleted file mode 100644 index 2c820b4..0000000 --- a/README.txt +++ /dev/null @@ -1,22 +0,0 @@ -Welcome to Apache Mahout! - -Getting Started - See http://mahout.apache.org - -From this directory - To compile, do `mvn -DskipTests clean install` - To run tests do `mvn test` - To set up your IDE, do `mvn eclipse:eclipse` or `mvn idea:idea` - -For more information on how to contribute see: - https://mahout.apache.org/developers/how-to-contribute.html - -Legal - Please see the NOTICE.txt included in this directory for more information. - -Documentation - See http://mahout.apache.org/ - -Note when running the spark-shell job it can help to set some JVM options so -you don't run out of memory: - `$MAHOUT_OPTS="-Xmx6g -XX:MaxPermSize=512m" mahout spark-shell`
