IGNITE-7509: Adjust documentation for ML module
authorOleg Ignatenko <oignatenko@gridgain.com>
Mon, 29 Jan 2018 17:21:52 +0000 (20:21 +0300)
committerYury Babak <ybabak@gridgain.com>
Mon, 29 Jan 2018 17:21:52 +0000 (20:21 +0300)
this closes #3449

modules/ml/README.txt
modules/yardstick/DEVNOTES-standalone.txt
modules/yardstick/DEVNOTES.txt

index e85b7a0..d7e2fb9 100644 (file)
@@ -1,21 +1,17 @@
-Apache Ignite Math Module
-------------------------------
+Apache Ignite ML Grid Module
+----------------------------
 
-Apache Ignite Math module provides several implementations of vector and matrices.
-
-Module includes on heap and off heap, dense and sparse, local and distributed implementations.
-
-Based on ideas from Apache Mahout.
+Apache Ignite ML Grid module provides machine learning features, along with involved methods of linear algebra and relevant data structures, including on heap and off heap, dense and sparse, local and distributed implementations.
 
 # Local build with javadoc
 
 Run from project root:
-mvn clean package -Pml -DskipTests -pl modules/ml -am
+mvn clean package -DskipTests -pl modules/ml -am
 
 Apache binary releases cannot include LGPL dependencies. If you would like to activate native BLAS optimizations
 into your build, you should download the source release
 from Ignite website and do the build with the following maven command:
 
-mvn clean package -Pml,lgpl -DskipTests -pl modules/ml -am
+mvn clean package -Plgpl -DskipTests -pl modules/ml -am
 
-Find generated jars in target folder.
\ No newline at end of file
+Find generated jars in target folder.
index 4636e8f..81808d1 100644 (file)
@@ -7,16 +7,6 @@ mvn clean package
 
 Artifacts can be found in `/target/assembly directory.`
 
-Building from standalone sources with ML Grid benchmarks
-====================================================
-
-You need Java 8 or higher and "ml" profile enabled. Run
-
-mvn clean package -Pml
-
-See also: https://apacheignite.readme.io/docs/machine-learning#section-getting-started
-
-
 Writing Ignite Benchmarks
 =========================
 
index 9f79f55..b8b1f53 100644 (file)
@@ -12,17 +12,6 @@ This command will compile the project and also unpack scripts from `yardstick-re
 
 Artifacts can be found in `modules/yardstick/target/assembly` directory.
 
-Building from Ignite sources with ML Grid benchmarks
-====================================================
-
-You need Java 8 or higher and "ml" profile enabled. Run
-
-mvn clean package -Pyardstick -Pml -pl modules/yardstick -am -DskipTests
-
-in the Apache Ignite root directory.
-
-See also: https://apacheignite.readme.io/docs/machine-learning#section-getting-started
-
 Writing Ignite Benchmarks
 =========================