[systemml] branch master updated: [DOC] Documentation for builtin winsorize 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 e0c87cc  [DOC] Documentation for builtin winsorize function
e0c87cc is described below

commit e0c87ccfe39cca0103e7190ff93ab7fd63d9d3ae
Author: Supratick Dey <su...@gmail.com>
AuthorDate: Mon Jun 8 15:20:54 2020 +0530

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

diff --git a/dev/docs/builtins-reference.md b/dev/docs/builtins-reference.md
index afc501f..7f306bf 100644
--- a/dev/docs/builtins-reference.md
+++ b/dev/docs/builtins-reference.md
@@ -41,6 +41,7 @@ limitations under the License.
     * [`naivebayes`-Function](#naivebayes-function)
     * [`outlier`-Function](#outlier-function)
     * [`toOneHot`-Function](#toOneHOt-function)
+    * [`winsorize`-Function](#winsorize-function)
     
     
 # Introduction
@@ -705,3 +706,30 @@ X = rand(rows = 50, cols = 10)
 y = round(X %*% rand(rows=ncol(X), cols=1))
 model = msvm(X = X, Y = y, intercept = FALSE, epsilon = 0.005, lambda = 1.0, maxIterations = 100, verbose = FALSE)
 ```
+
+## `winsorize`-Function
+
+The `winsorize`-function removes outliers from the data. It does so by computing upper and lower quartile range
+of the given data then it replaces any value that falls outside this range (less than lower quartile range or more
+than upper quartile range).
+
+### Usage
+```r
+winsorize(X)
+```
+
+### Arguments
+| Name     | Type           | Default  | Description |
+| :------- | :------------- | :--------| :---------- |
+| X        | Matrix[Double] | required | recorded data set with possible outlier values |
+
+### Returns
+| Type           | Description |
+| :------------- | :---------- |
+| Matrix[Double] | Matrix without outlier values |
+
+### Example
+```r
+X = rand(rows=10, cols=10,min = 1, max=9)
+Y = winsorize(X=X)
+```