From 828b3a3813fdf7234dd47b17fbe84fe1d10eb817 Mon Sep 17 00:00:00 2001 From: liqiotng Date: Sat, 12 Mar 2022 23:36:35 +0800 Subject: [PATCH 1/7] corrcoef_doc --- docs/api/paddle/linalg/corrcoef_cn.rst | 40 ++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/api/paddle/linalg/corrcoef_cn.rst diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst new file mode 100644 index 00000000000..a4f6c36b680 --- /dev/null +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -0,0 +1,40 @@ +.. _cn_api_linalg_corrcoef: + +corrcoef +------------------------------- + +.. py:function:: paddle.linalg.corrcoef(x, rowvar=True, ddof=False, name=None) + + +给定输入Tensor，计算输入Tensor的皮尔逊积矩相关系数矩阵。 + +皮尔逊积矩相关系数矩阵是一个方阵，用于指示每两个输入元素之间的皮尔逊积矩相关系数。 +例如对于有N个元素的输入X=[x1,x2,…xN]T，皮尔逊积矩相关系数矩阵的元素Cij表示输入xi和xj之间的皮尔逊积矩相关系数，Cii表示xi其自身的皮尔逊积矩相关系数。 + +参数： +::::::::: + - **x** (Tensor) - 一个N(N<=2)维矩阵，包含多个变量。默认矩阵的每行是一个观测变量，由参数rowvar设置。 + - **rowvar** (bool, 可选) - 若是True，则每行作为一个观测变量；若是False，则每列作为一个观测变量。默认True。 + - **ddof** (bool, 可选) - 在计算中不起作用，不需要。默认False。 + +返回： +::::::::: + - Tensor, 输入x的皮尔逊积矩相关系数矩阵。假设x是[m,n]的矩阵，rowvar=True, 则输出为[m,m]的矩阵。 + +代码示例： +:::::::::: + +.. code-block:: python + + import paddle + + xt = paddle.rand((3,4)) + paddle.linalg.corrcoef(xt) + + ''' + Tensor(shape=[3, 3], dtype=float32, place=Place(cpu), stop_gradient=True, + [[ 1. , -0.73702252, 0.66228950], + [-0.73702258, 1. , -0.77104872], + [ 0.66228974, -0.77104825, 1. ]]) + ''' + \ No newline at end of file From a4a4b92de823db87719316f4eaee08911b4a47b9 Mon Sep 17 00:00:00 2001 From: liqitong-a <71805392+liqitong-a@users.noreply.github.com> Date: Fri, 18 Mar 2022 17:04:58 +0800 Subject: [PATCH 2/7] Update corrcoef_cn.rst --- docs/api/paddle/linalg/corrcoef_cn.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst index a4f6c36b680..56ce2659e98 100644 --- a/docs/api/paddle/linalg/corrcoef_cn.rst +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -7,19 +7,22 @@ corrcoef 给定输入Tensor，计算输入Tensor的皮尔逊积矩相关系数矩阵。 +细节请参考cov文档. 皮尔逊积矩相关系数 `R`和 协方差矩阵`C`的关系如下： -皮尔逊积矩相关系数矩阵是一个方阵，用于指示每两个输入元素之间的皮尔逊积矩相关系数。 -例如对于有N个元素的输入X=[x1,x2,…xN]T，皮尔逊积矩相关系数矩阵的元素Cij表示输入xi和xj之间的皮尔逊积矩相关系数，Cii表示xi其自身的皮尔逊积矩相关系数。 + .. math:: R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } } + + `R`的值在-1到1之间. 参数： ::::::::: - **x** (Tensor) - 一个N(N<=2)维矩阵，包含多个变量。默认矩阵的每行是一个观测变量，由参数rowvar设置。 - **rowvar** (bool, 可选) - 若是True，则每行作为一个观测变量；若是False，则每列作为一个观测变量。默认True。 - **ddof** (bool, 可选) - 在计算中不起作用，不需要。默认False。 + - **name** (str, 可选) - 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回： ::::::::: - - Tensor, 输入x的皮尔逊积矩相关系数矩阵。假设x是[m,n]的矩阵，rowvar=True, 则输出为[m,m]的矩阵。 + - Tensor, 输入x的皮尔逊积矩相关系数矩阵。 代码示例： :::::::::: @@ -37,4 +40,4 @@ corrcoef [-0.73702258, 1. , -0.77104872], [ 0.66228974, -0.77104825, 1. ]]) ''' - \ No newline at end of file + From b2a94787c1db882fb4862bbd63a253d3d6bff727 Mon Sep 17 00:00:00 2001 From: liqitong-a <71805392+liqitong-a@users.noreply.github.com> Date: Thu, 7 Apr 2022 14:23:47 +0800 Subject: [PATCH 3/7] Update corrcoef_cn.rst --- docs/api/paddle/linalg/corrcoef_cn.rst | 36 ++++++++------------------ 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst index 56ce2659e98..1086d25a02e 100644 --- a/docs/api/paddle/linalg/corrcoef_cn.rst +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -3,41 +3,27 @@ corrcoef ------------------------------- -.. py:function:: paddle.linalg.corrcoef(x, rowvar=True, ddof=False, name=None) +.. py:function:: paddle.linalg.corrcoef(x, rowvar=True, name=None) 给定输入Tensor，计算输入Tensor的皮尔逊积矩相关系数矩阵。 -细节请参考cov文档. 皮尔逊积矩相关系数 `R`和 协方差矩阵`C`的关系如下： +细节请参考 `cov文档 https://github.com/PaddlePaddle/docs/blob/develop/docs/api/paddle/linalg/cov_cn.rst` 。 +皮尔逊积矩相关系数 `R` 和协方差矩阵 `C` 的关系如下： .. math:: R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } } - `R`的值在-1到1之间. + `R` 的值在-1到1之间。 -参数： +参数 ::::::::: - **x** (Tensor) - 一个N(N<=2)维矩阵，包含多个变量。默认矩阵的每行是一个观测变量，由参数rowvar设置。 - - **rowvar** (bool, 可选) - 若是True，则每行作为一个观测变量；若是False，则每列作为一个观测变量。默认True。 - - **ddof** (bool, 可选) - 在计算中不起作用，不需要。默认False。 - - **name** (str, 可选) - 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + - **rowvar** (bool，可选) - 若是True，则每行作为一个观测变量；若是False，则每列作为一个观测变量。默认True。 + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为None。 -返回： +返回 ::::::::: - - Tensor, 输入x的皮尔逊积矩相关系数矩阵。 + - Tensor，输入x的皮尔逊积矩相关系数矩阵。 -代码示例： +代码示例 :::::::::: - -.. code-block:: python - - import paddle - - xt = paddle.rand((3,4)) - paddle.linalg.corrcoef(xt) - - ''' - Tensor(shape=[3, 3], dtype=float32, place=Place(cpu), stop_gradient=True, - [[ 1. , -0.73702252, 0.66228950], - [-0.73702258, 1. , -0.77104872], - [ 0.66228974, -0.77104825, 1. ]]) - ''' - +COPY-FROM: : From d70c75bd8655f4b64ffb1727a2d7cf9eeb0ea055 Mon Sep 17 00:00:00 2001 From: liqitong-a <71805392+liqitong-a@users.noreply.github.com> Date: Thu, 7 Apr 2022 15:14:03 +0800 Subject: [PATCH 4/7] Update corrcoef_cn.rst --- docs/api/paddle/linalg/corrcoef_cn.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst index 1086d25a02e..f2d15e218a5 100644 --- a/docs/api/paddle/linalg/corrcoef_cn.rst +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -6,11 +6,12 @@ corrcoef .. py:function:: paddle.linalg.corrcoef(x, rowvar=True, name=None) -给定输入Tensor，计算输入Tensor的皮尔逊积矩相关系数矩阵。 -细节请参考 `cov文档 https://github.com/PaddlePaddle/docs/blob/develop/docs/api/paddle/linalg/cov_cn.rst` 。 +相关系数矩阵表示输入矩阵中每对变量的相关性。例如，对于N维样本X=[x1，x2，…xN]T，则相关系数矩阵 +元素 `Rij` 是 `xi` 和 `xj` 的相关性。元素 `Rii` 是 `xi` 本身的协方差。 + 皮尔逊积矩相关系数 `R` 和协方差矩阵 `C` 的关系如下： - .. math:: R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } } + .. math:: R_{ij} = C_{ij} / sqrt{ C_{ii} * C_{jj} } `R` 的值在-1到1之间。 @@ -18,11 +19,11 @@ corrcoef ::::::::: - **x** (Tensor) - 一个N(N<=2)维矩阵，包含多个变量。默认矩阵的每行是一个观测变量，由参数rowvar设置。 - **rowvar** (bool，可选) - 若是True，则每行作为一个观测变量；若是False，则每列作为一个观测变量。默认True。 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为None。 + - **name** (str，可选) - 一般无需设置，默认值为None。用于为开发人员打印调试信息。具体用法请参见 :ref:`api_guide_Name`。 返回 ::::::::: - - Tensor，输入x的皮尔逊积矩相关系数矩阵。 + 输入x的皮尔逊积矩相关系数矩阵。 代码示例 :::::::::: From 5121887c973755194f291d084f7b92fd53269977 Mon Sep 17 00:00:00 2001 From: liqitong-a <71805392+liqitong-a@users.noreply.github.com> Date: Thu, 7 Apr 2022 19:03:38 +0800 Subject: [PATCH 5/7] Update corrcoef_cn.rst --- docs/api/paddle/linalg/corrcoef_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst index f2d15e218a5..a5e14f864d8 100644 --- a/docs/api/paddle/linalg/corrcoef_cn.rst +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -11,7 +11,7 @@ corrcoef 皮尔逊积矩相关系数 `R` 和协方差矩阵 `C` 的关系如下： - .. math:: R_{ij} = C_{ij} / sqrt{ C_{ii} * C_{jj} } + .. math:: R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } } `R` 的值在-1到1之间。 From ee9366058e6da5c37ed0b89d9acfd0408079bcef Mon Sep 17 00:00:00 2001 From: liqitong-a <71805392+liqitong-a@users.noreply.github.com> Date: Fri, 8 Apr 2022 10:49:19 +0800 Subject: [PATCH 6/7] Update corrcoef_cn.rst --- docs/api/paddle/linalg/corrcoef_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst index a5e14f864d8..83d968f7ea9 100644 --- a/docs/api/paddle/linalg/corrcoef_cn.rst +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -11,7 +11,7 @@ corrcoef 皮尔逊积矩相关系数 `R` 和协方差矩阵 `C` 的关系如下： - .. math:: R_{ij} = \\frac{ C_{ij} } { \\sqrt{ C_{ii} * C_{jj} } } + .. math:: R_{ij} = \frac{ C_{ij} } { \sqrt{ C_{ii} * C_{jj} } } `R` 的值在-1到1之间。 From 084779da75b321d8fec8f1389246060a03cbdad7 Mon Sep 17 00:00:00 2001 From: Ligoml <39876205+Ligoml@users.noreply.github.com> Date: Sat, 7 May 2022 18:23:59 +0800 Subject: [PATCH 7/7] Update corrcoef_cn.rst --- docs/api/paddle/linalg/corrcoef_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/linalg/corrcoef_cn.rst b/docs/api/paddle/linalg/corrcoef_cn.rst index 83d968f7ea9..f25980aeea0 100644 --- a/docs/api/paddle/linalg/corrcoef_cn.rst +++ b/docs/api/paddle/linalg/corrcoef_cn.rst @@ -27,4 +27,4 @@ corrcoef 代码示例 :::::::::: -COPY-FROM: : +COPY-FROM: paddle.linalg.corrcoef:code-example1