You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by ra...@apache.org on 2020/10/14 18:53:09 UTC
[mahout] branch trunk updated: Made grammatical,
punctuation corrections in the README.md file to make the text
robust, grammar-proof
This is an automated email from the ASF dual-hosted git repository.
rawkintrevo pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/trunk by this push:
new d041b3f Made grammatical, punctuation corrections in the README.md file to make the text robust, grammar-proof
new 7acc864 Merge pull request #409 from royadityak94/patch-1
d041b3f is described below
commit d041b3fcec7e0b973f0b411bf49fb28719233eca
Author: Addy Roy <57...@users.noreply.github.com>
AuthorDate: Wed Oct 14 03:58:50 2020 -0400
Made grammatical, punctuation corrections in the README.md file to make the text robust, grammar-proof
Applied grammatical corrections throughout the README.md files at several places to avoid the confusion arising from incorrect punctuations, grammatical.
---
README.md | 36 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 44ad466..2e1c8a1 100644
--- a/README.md
+++ b/README.md
@@ -17,12 +17,12 @@ limitations under the License.
Welcome to Apache Mahout!
===========
-The Apache Mahout™ project's goal is to build an environment for quickly creating scalable performant machine learning applications.
+The goal of the Apache Mahout™ project 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
+Whether you are using the Mahout- shell, running command line jobs, or using it as a library to build apps, you will need to set-up 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,
@@ -37,7 +37,7 @@ To compile from source:
* 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 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:
@@ -60,7 +60,7 @@ and a dependency for back end engine translation, e.g:
###### Prerequisites:
-Linux Environment (preferably Ubuntu 16.04.x) Note: Currently only the JVM-only build will work on a Mac.
+Linux Environment (preferably Ubuntu 16.04.x) Note: Currently, only the JVM-only build will work on a Mac.
gcc > 4.x
NVIDIA Card (installed with OpenCL drivers alongside usual GPU drivers)
@@ -69,7 +69,7 @@ NVIDIA Card (installed with OpenCL drivers alongside usual GPU drivers)
Install java 1.7+ in an easily accessible directory (for this example, ~/java/)
http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
-Create a directory ~/apache/ .
+Create a directory ~/apache/.
Download apache Maven 3.3.9 and un-tar/gunzip to ~/apache/apache-maven-3.3.9/ .
https://maven.apache.org/download.cgi
@@ -80,7 +80,7 @@ https://archive.apache.org/dist/hadoop/common/hadoop-2.4.1/
Download and un-tar/gunzip spark-1.6.3-bin-hadoop2.4 to ~/apache/ .
http://spark.apache.org/downloads.html
Choose release: Spark-1.6.3 (Nov 07 2016)
-Choose package type: Pre-Built for Hadoop 2.4
+Choose a package type: Pre-Built for Hadoop 2.4
Install ViennaCL 1.7.0+
If running Ubuntu 16.04+
@@ -98,7 +98,7 @@ cp -r viennacl/ /usr/local/
cp -r CL/ /usr/local/
```
-Ensure that the OpenCL 1.2+ drivers are installed (packed with most consumer grade NVIDIA drivers). Not sure about higher end cards.
+Ensure that the OpenCL 1.2+ drivers are all installed (packed with most consumer-grade NVIDIA drivers). Not sure about higher-end cards.
Clone mahout repository into `~/apache`.
@@ -116,9 +116,9 @@ When building mahout for a spark backend, we need four System Environment variab
export JAVA_HOME=/home/<user>/java/jdk-1.8.121
```
-Mahout on Spark regularly uses one more env variable, the IP of the Spark cluster’s master node (usually the node which one would be logged into).
+Mahout on Spark regularly uses one more env variable, the IP of the Spark clusters' master node (usually, the node hosting the session user).
-To use 4 local cores (Spark master need not be running)
+To use four local cores (Spark master need not be running)
```
export MASTER=local[4]
```
@@ -137,12 +137,12 @@ We then add these to the path:
PATH=$PATH$:MAHOUT_HOME/bin:$HADOOP_HOME/bin:$SPARK_HOME/bin:$JAVA_HOME/bin
```
-These should be added to the your ~/.bashrc file.
+These get appended to the users' ~/.bashrc file.
###### Building Mahout with Apache Maven
-Currently Mahout has 3 builds. From the $MAHOUT_HOME directory we may issue the commands to build each using mvn profiles.
+Currently, Mahout has three builds. From the $MAHOUT_HOME directory, we may issue the commands to build each using mvn profiles.
JVM only:
```
@@ -153,16 +153,16 @@ JVM with native OpenMP level 2 and level 3 matrix/vector Multiplication
```
mvn clean install -Pviennacl-omp -Phadoop2 -DskipTests
```
-JVM with native OpenMP and OpenCL for Level 2 and level 3 matrix/vector Multiplication. (GPU errors fall back to OpenMP, currently only a single GPU/node is supported).
+JVM with native OpenMP and OpenCL for Level 2 and level 3 matrix/vector Multiplication. (GPU errors fall back to OpenMP, and currently, only a single GPU/node is supported).
```
mvn clean install -Pviennacl -Phadoop2 -DskipTests
```
#### Testing the Mahout Environment
-Mahout provides an extension to the spark-shell, which is good for getting to know the language, testing partition loads, prototyping algorithms, etc..
+Mahout provides an extension to the spark-shell that is good for getting to know the language, testing partition loads, prototyping algorithms, etc.
-To launch the shell in local mode with 2 threads: simply do the following:
+To launch the shell in local mode with two threads - simply do the following:
```
$ MASTER=local[2] mahout spark-shell
```
@@ -201,9 +201,9 @@ Which will load a matrix multiplication timer function definition. To run the ma
scala> timeSparseDRMMMul(1000,1000,1000,1,.02,1234L)
{...} res3: Long = 16321
```
-Note the 14.1 release is missing a class required for this; will be fixed in 14.2. We can see that the JVM only version is rather slow, thus our motive for GPU and Native Multithreading support.
+Note the 14.1 release is missing a class required for this will be fixed in 14.2. We can see that the JVM only version is slow, thus our motive for GPU and Native Multithreading support.
-To get an idea of what’s going on under the hood of the timer, we may examine the .mscala (mahout scala) code which is both fully functional scala and the Mahout R-Like DSL for tensor algebra:
+To understand the processes getting performed under the hood of the timer, we may examine the .mscala (mahout scala) code that is both fully functional scala and the Mahout R-Like DSL for tensor algebra:
```
@@ -241,7 +241,7 @@ def timeSparseDRMMMul(m: Int, n: Int, s: Int, para: Int, pctDense: Double = .20,
}
```
-For more information please see the following references:
+For more information, please see the following references:
http://mahout.apache.org/users/environment/in-core-reference.html
@@ -251,7 +251,7 @@ http://mahout.apache.org/users/sparkbindings/play-with-shell.html
http://mahout.apache.org/users/environment/classify-a-doc-from-the-shell.html
-Note that due to an intermittent out-of-memory bug in a Flink test we have disabled it from the binary releases. To use Flink please uncomment the line in the root pom.xml in the `<modules>` block so it reads `<module>flink</module>`.
+Note that due to an intermittent out-of-memory bug in a Flink-based test, we have disabled it from the binary releases. To use Flink, please uncomment the line in the root pom.xml in the `<modules>` block, so it reads `<module>flink</module>`.
#### Examples
For examples of how to use Mahout, see the examples directory located in `examples/bin`