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

commit efd89db58b10166e7045ad9125228ee15c1e9b89
Author: Karishma Sinha <3s...@gmail.com>
AuthorDate: Mon Jun 8 15:37:49 2020 +0530

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

diff --git a/dev/docs/builtins-reference.md b/dev/docs/builtins-reference.md
index 7f306bf..e72251d 100644
--- a/dev/docs/builtins-reference.md
+++ b/dev/docs/builtins-reference.md
@@ -31,6 +31,7 @@ limitations under the License.
     * [`lmCG`-Function](#lmcg-function)
     * [`lmpredict`-Function](#lmpredict-function)
     * [`mice`-Function](#mice-function)
+    * [`pnmf`-Function](#pnmf-function)
     * [`scale`-Function](#scale-function)
     * [`sigmoid`-Function](#sigmoid-function)
     * [`steplm`-Function](#steplm-function)
@@ -386,6 +387,39 @@ cMask = round(rand(rows=1,cols=ncol(F),min=0,max=1))
 [dataset, singleSet] = mice(F, cMask, iter = 3, complete = 3, verbose = FALSE)
 ```
 
+## `pnmf`-Function
+
+The `pnmf`-function implements Poisson Non-negative Matrix Factorization (PNMF). Matrix `X` is factorized into
+two non-negative matrices, `W` and `H` based on Poisson probabilistic assumption. This non-negativity makes the
+resulting matrices easier to inspect.
+
+### Usage
+```r
+pnmf(X, rnk, eps = 10^-8, maxi = 10, verbose = TRUE)
+```
+
+### Arguments
+| Name    | Type           | Default  | Description |
+| :------ | :------------- | -------- | :---------- |
+| X       | Matrix[Double] | required | Matrix of feature vectors. |
+| rnk     | Integer        | required | Number of components into which matrix X is to be factored. |
+| eps     | Double         | `10^-8`  | Tolerance |
+| maxi    | Integer        | `10`     | Maximum number of conjugate gradient iterations. |
+| verbose | Boolean        | TRUE     | If TRUE, 'iter' and 'obj' are printed.|
+
+
+### Returns
+| Type           | Description |
+| :------------- | :---------- |
+| Matrix[Double] | List of pattern matrices, one for each repetition. |
+| Matrix[Double] | List of amplitude matrices, one for each repetition. |
+
+### Example
+```r
+X = rand(rows = 50, cols = 10)
+[W, H] = pnmf(X = X, rnk = 2, eps = 10^-8, maxi = 10, verbose = TRUE)
+```
+
 ## `scale`-Function
 
 The scale function is a generic function whose default method centers or scales the column of a numeric matrix.