[systemml] branch master updated: [DOC] Documentation for builtin normalize function

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

janardhan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/systemml.git


The following commit(s) were added to refs/heads/master by this push:
     new 719ebe0  [DOC] Documentation for builtin normalize function
719ebe0 is described below

commit 719ebe0d215035c054c435a5b7d790e643ec0fe1
Author: Karishma Sinha <es...@gmail.com>
AuthorDate: Tue Jun 2 12:29:09 2020 +0530

    [DOC] Documentation for builtin normalize function
    
    Closes #935.
---
 dev/docs/builtins-reference.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/dev/docs/builtins-reference.md b/dev/docs/builtins-reference.md
index c2114dd..6ca4870 100644
--- a/dev/docs/builtins-reference.md
+++ b/dev/docs/builtins-reference.md
@@ -31,6 +31,8 @@ limitations under the License.
     * [`sigmoid`-Function](#sigmoid-function)
     * [`steplm`-Function](#steplm-function)
     * [`slicefinder`-Function](#slicefinder-function)
+    * [`normalize`-Function](#normalize-function)
+
     
     
 # Introduction
@@ -382,3 +384,34 @@ y = X %*% rand(rows = ncol(X), cols = 1)
 w = lm(X = X, y = y)
 ress = slicefinder(X = X,W = w, Y = y,  k = 5, paq = 1, S = 2);
 ```
+## `normalize`-Function
+
+The `normalize`-function normalises the values of a matrix by changing the dataset to use a common scale.
+This is done while preserving differences in the ranges of values. 
+The output is a matrix of values in range [0,1].
+
+### Usage
+```r
+normalize(X); 
+```
+
+### Arguments
+| Name    | Type           | Default  | Description |
+| :------ | :------------- | -------- | :---------- |
+| X       | Matrix[Double] | required | Matrix of feature vectors. |
+
+
+### Returns
+| Type           | Description |
+| :------------- | :---------- |
+| Matrix[Double] | 1-column matrix of normalized values. |
+
+
+
+### Example
+```r
+X = rand(rows = 50, cols = 10)
+y = X %*% rand(rows=ncol(X), cols=1)
+y = normalize(X = X)
+
+```