[DOC] Documentation for builtin scale function
Closes #934.
diff --git a/dev/docs/builtins-reference.md b/dev/docs/builtins-reference.md
index 3627bd8..c2114dd 100644
--- a/dev/docs/builtins-reference.md
+++ b/dev/docs/builtins-reference.md
@@ -27,6 +27,7 @@
* [`lmDS`-Function](#lmds-function)
* [`lmCG`-Function](#lmcg-function)
* [`lmpredict`-Function](#lmpredict-function)
+ * [`scale`-Function](#scale-function)
* [`sigmoid`-Function](#sigmoid-function)
* [`steplm`-Function](#steplm-function)
* [`slicefinder`-Function](#slicefinder-function)
@@ -110,6 +111,7 @@
**DML-bodied built-in functions** are written as DML-Scripts and executed as such when called.
+
## `lm`-Function
The `lm`-function solves linear regression using either the **direct solve method** or the **conjugate gradient algorithm**
@@ -246,6 +248,35 @@
yp = lmpredict(X, w)
```
+## `scale`-Function
+
+The scale function is a generic function whose default method centers or scales the column of a numeric matrix.
+
+### Usage
+```r
+scale(X, center=TRUE, scale=TRUE)
+```
+
+### Arguments
+| Name | Type | Default | Description |
+| :------ | :------------- | -------- | :---------- |
+| X | Matrix[Double] | required | Matrix of feature vectors. |
+| center | Boolean | required | either a logical value or numerical value. |
+| scale | Boolean | required | either a logical value or numerical value. |
+
+### Returns
+| Type | Description |
+| :------------- | :---------- |
+| Matrix[Double] | 1-column matrix of weights. |
+
+### Example
+```r
+X = rand(rows = 20, cols = 10)
+center=TRUE;
+scale=TRUE;
+Y= scale(X,center,scale)
+```
+
## `sigmoid`-Function
The Sigmoid function is a type of activation function, and also defined as a squashing function which limit the output
