Repository: incubator-systemml Updated Branches: refs/heads/gh-pages d2a048d72 -> 0b46ddb21
[SYSTEMML-823] Update Standalone Guide univar stats example Restore table describing univariate statistics numbers. Update global template from Quick Start Guide to Standalone Guide. Add Engine Developer Guide to global template. Closes #209. Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/0b46ddb2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/0b46ddb2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/0b46ddb2 Branch: refs/heads/gh-pages Commit: 0b46ddb215dac63b87461a41c34910b6c416bca7 Parents: d2a048d Author: Deron Eriksson <[email protected]> Authored: Thu Aug 11 17:44:02 2016 -0700 Committer: Deron Eriksson <[email protected]> Committed: Thu Aug 11 17:44:02 2016 -0700 ---------------------------------------------------------------------- _layouts/global.html | 3 ++- standalone-guide.md | 47 +++++++++++++++++++++++++++++++++++++---------- 2 files changed, 39 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/0b46ddb2/_layouts/global.html ---------------------------------------------------------------------- diff --git a/_layouts/global.html b/_layouts/global.html index 71a151f..e650cf8 100644 --- a/_layouts/global.html +++ b/_layouts/global.html @@ -47,7 +47,7 @@ <ul class="dropdown-menu" role="menu"> <li><b>Running SystemML:</b></li> <li><a href="https://github.com/apache/incubator-systemml">SystemML GitHub README</a></li> - <li><a href="standalone-guide.html">Quick Start Guide</a></li> + <li><a href="standalone-guide.html">Standalone Guide</a></li> <li><a href="spark-mlcontext-programming-guide.html">Spark MLContext Programming Guide</a></li> <li><a href="hadoop-batch-mode.html">Hadoop Batch Mode</a> <li><a href="jmlc.html">Java Machine Learning Connector (JMLC)</a> @@ -65,6 +65,7 @@ <li class="divider"></li> <li><b>Other:</b></li> <li><a href="contributing-to-systemml.html">Contributing to SystemML</a></li> + <li><a href="engine-dev-guide.html">Engine Developer Guide</a></li> <li><a href="troubleshooting-guide.html">Troubleshooting Guide</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/0b46ddb2/standalone-guide.md ---------------------------------------------------------------------- diff --git a/standalone-guide.md b/standalone-guide.md index 38b6497..2c2092d 100644 --- a/standalone-guide.md +++ b/standalone-guide.md @@ -50,11 +50,11 @@ algorithms can be found in the [Algorithms Reference](algorithms-reference.html) # Download SystemML -Apache incubator releases of SystemML are available from the [downloads](http://systemml.apache.org/download.html) page. +Apache incubator releases of SystemML are available from the [Downloads](http://systemml.apache.org/download.html) page. +SystemML can also be downloaded from GitHub and built with Maven. The SystemML project is available on GitHub at [https://github.com/apache/incubator-systemml](https://github.com/apache/incubator-systemml). -SystemML can be downloaded from GitHub and built with Maven. Instructions to build and -test SystemML can be found in the [SystemML GitHub README](https://github.com/apache/incubator-systemml). +Instructions to build SystemML can be found in the <a href="engine-dev-guide.html">Engine Developer Guide</a>. # Standalone vs Distributed Execution Mode @@ -91,7 +91,8 @@ data file `<filename>` must be `<filename>.mtd`. $ echo '{"rows": 306, "cols": 4, "format": "csv"}' > data/haberman.data.mtd -<br/> + +--- # Example 1 - Univariate Statistics @@ -170,9 +171,10 @@ To run the `Univar-Stats.dml` algorithm, issue the following command (we set the (17) Num of modes | 1 -The `Univar-Stats.dml` script writes the computed statistics to the `univarOut.mtx` file. The matrix has one row per univariate statistic and one column per input feature. The first column gives the number of the statistic -(see above table), the second column gives the number of the feature column in -the input data, and the third column gives the value of the univariate statistic. +In addition to writing statistics to the console, the `Univar-Stats.dml` script writes the computed statistics +to the `data/univarOut.mtx` file specified by the STATS input parameter. + +**univarOut.mtx file** 1 1 30.0 1 2 58.0 @@ -219,9 +221,33 @@ the input data, and the third column gives the value of the univariate statistic 16 4 1.0 17 4 1.0 +The following table lists the number and name of each univariate statistic. The row +numbers below correspond to the elements of the first column in the output +matrix above. The signs "+" show applicability to scale or/and to categorical +features. + + | Row | Name of Statistic | Scale | Categ. | + | :-: |:-------------------------- |:-----:| :-----:| + | 1 | Minimum | + | | + | 2 | Maximum | + | | + | 3 | Range | + | | + | 4 | Mean | + | | + | 5 | Variance | + | | + | 6 | Standard deviation | + | | + | 7 | Standard error of mean | + | | + | 8 | Coefficient of variation | + | | + | 9 | Skewness | + | | + | 10 | Kurtosis | + | | + | 11 | Standard error of skewness | + | | + | 12 | Standard error of kurtosis | + | | + | 13 | Median | + | | + | 14 | Inter quartile mean | + | | + | 15 | Number of categories | | + | + | 16 | Mode | | + | + | 17 | Number of modes | | + | -<br/> -<br/> + +--- # Example 2 - Binary-class Support Vector Machines @@ -338,7 +364,8 @@ If the confusion matrix looks like this ... Refer to the [Algorithms Reference](algorithms-reference.html) for more details. -<br/> + +--- # Example 3 - Linear Regression
