You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@systemml.apache.org by GitBox <gi...@apache.org> on 2020/06/01 18:01:00 UTC
[GitHub] [systemml] escher-m opened a new pull request #935: [DOC] Documentation for builtin normalize function
escher-m opened a new pull request #935:
URL: https://github.com/apache/systemml/pull/935
I have tried adding documentation for the normalize function. Please review changes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [systemml] escher-m commented on pull request #935: [DOC] Documentation for builtin normalize function
Posted by GitBox <gi...@apache.org>.
escher-m commented on pull request #935:
URL: https://github.com/apache/systemml/pull/935#issuecomment-637301776
Made the code consistent
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [systemml] j143 commented on pull request #935: [DOC] Documentation for builtin normalize function
Posted by GitBox <gi...@apache.org>.
j143 commented on pull request #935:
URL: https://github.com/apache/systemml/pull/935#issuecomment-637304525
Thank you, @escher-m - LGTM. 👍
🥳 🚀
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [systemml] j143 commented on a change in pull request #935: [DOC] Documentation for builtin normalize function
Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #935:
URL: https://github.com/apache/systemml/pull/935#discussion_r433636919
##########
File path: dev/docs/builtins-reference.md
##########
@@ -351,3 +353,32 @@ 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 is used for data preparation by normalization. Here, the values of a matrix (numeric columns) are changed in the dataset to use a common scale, while preserving differences in the ranges of values.
+
+### 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)
Review comment:
Also, `y = normalize(X = X)` or `y=normalize(X = X)` can be used consistently.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [GitHub] [systemml] escher-m opened a new pull request #935:
[DOC] Documentation for builtin normalize function
Posted by Janardhan <ja...@gmail.com>.
Will review this in a while.
On Mon, Jun 1, 2020 at 11:31 PM GitBox <gi...@apache.org> wrote:
>
> escher-m opened a new pull request #935:
> URL: https://github.com/apache/systemml/pull/935
>
>
> I have tried adding documentation for the normalize function. Please
> review changes.
>
>
> ----------------------------------------------------------------
> This is an automated message from the Apache Git Service.
> To respond to the message, please log on to GitHub and use the
> URL above to go to the specific comment.
>
> For queries about this service, please contact Infrastructure at:
> users@infra.apache.org
>
>
>
[GitHub] [systemml] j143 commented on a change in pull request #935: [DOC] Documentation for builtin normalize function
Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #935:
URL: https://github.com/apache/systemml/pull/935#discussion_r433635340
##########
File path: dev/docs/builtins-reference.md
##########
@@ -351,3 +353,32 @@ 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 is used for data preparation by normalization. Here, the values of a matrix (numeric columns) are changed in the dataset to use a common scale, while preserving differences in the ranges of values.
Review comment:
The lines can be wrapped for readability. :)
358 .... (numeric columns)
359 are changed ...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [systemml] asfgit closed pull request #935: [DOC] Documentation for builtin normalize function
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #935:
URL: https://github.com/apache/systemml/pull/935
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [systemml] j143 commented on a change in pull request #935: [DOC] Documentation for builtin normalize function
Posted by GitBox <gi...@apache.org>.
j143 commented on a change in pull request #935:
URL: https://github.com/apache/systemml/pull/935#discussion_r433636526
##########
File path: dev/docs/builtins-reference.md
##########
@@ -351,3 +353,32 @@ 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 is used for data preparation by normalization. Here, the values of a matrix (numeric columns) are changed in the dataset to use a common scale, while preserving differences in the ranges of values.
+
+### 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)
Review comment:
In the first line: `X = rand(rows = 50, cols = 10)`
In the second line: `y = ..... rand(rows = ncol(X), cols = 1)`
Let's use the same style through out!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org