forked from mindspore-Ecosystem/mindspore
47 lines
3.0 KiB
ReStructuredText
47 lines
3.0 KiB
ReStructuredText
|
mindspore.ops.cov
|
|||
|
|
==================
|
|||
|
|
|
|||
|
|
.. py:function:: mindspore.ops.cov(x, *, correction=1, fweights=None, aweights=None)
|
|||
|
|
|
|||
|
|
估计由输入矩阵给出的变量的协方差矩阵，其中行是变量，列是观察值。
|
|||
|
|
|
|||
|
|
协方差矩阵是给出每对变量的协方差的方阵。对角线包含每个变量的方差（变量与其自身的协方差）。根据定义，如果 `x` 表示单个变量(标量或一维)，则返回其方差。
|
|||
|
|
|
|||
|
|
变量 :math:`a` 和 :math:`b` 的无偏样本协方差由下式给出：
|
|||
|
|
|
|||
|
|
.. math::
|
|||
|
|
\text{cov}_w(a,b) = \frac{\sum^{N}_{i = 1}(a_{i} - \bar{a})(b_{i} - \bar{b})}{N~-~1}
|
|||
|
|
|
|||
|
|
其中 :math:`\bar{a}` 和 :math:`\bar{b}` 分别是 :math:`a` 和 :math:`b` 的简单均值。
|
|||
|
|
|
|||
|
|
如果提供了 `fweights` 和/或 `aweights` ，则计算无偏加权协方差，由下式给出：
|
|||
|
|
|
|||
|
|
.. math::
|
|||
|
|
\text{cov}_w(a,b) = \frac{\sum^{N}_{i = 1}w_i(a_{i} - \mu_a^*)(b_{i} - \mu_b^*)}{\sum^{N}_{i = 1}w_i~-~1}
|
|||
|
|
|
|||
|
|
其中 :math:`w` 基于提供的 `fweights` 或 `aweights` 中的任意一个参数进行表示，如果两个参数都有提供，则 :math:`w = fweights \times aweights`，并且 :math:`\mu_x^* = \frac{\sum^{N}_{i = 1}w_ix_{i} }{\sum^{N}_{i = 1}w_i}` 表示变量的加权平均值。
|
|||
|
|
|
|||
|
|
.. warning::
|
|||
|
|
`fweights` 和 `aweights` 的值不能为负数，负数权重场景结果未定义。
|
|||
|
|
|
|||
|
|
参数：
|
|||
|
|
- **x** (Tensor) - 包含多个变量和观察值的二维矩阵，或表示单个变量的标量或一维向量。
|
|||
|
|
|
|||
|
|
关键字参数：
|
|||
|
|
- **correction** (int，可选) - 样本量和样本自由度之间的差异，默认为Bessel校正 `correction = 1`，即使指定了 `fweights` 和 `aweights` 的情况下它也会返回无偏估计。`correction = 0` 将返回简单平均值。默认值：1。
|
|||
|
|
- **fweights** (Tensor, 可选) - 观察向量频率的标量或一维Tensor，表示每个观察应重复的次数。它的numel必须等于输入 `x` 的列数。必须为整型数据类型。若为None则忽略。默认值：None。
|
|||
|
|
- **aweights** (Tensor, 可选) - 观察向量权重的标量或一维数组。对于较为重要的观察值，这些相对权重通常较大，而对于相对不够重要的观察值，这些相对权重较小。它的numel必须等于输入 `x` 的列数。必须为浮点数据类型。若为None则忽略。默认值：None。
|
|||
|
|
|
|||
|
|
返回：
|
|||
|
|
Tensor，入参的协方差矩阵计算结果。
|
|||
|
|
|
|||
|
|
异常：
|
|||
|
|
- **ValueError** - 如果输入的维度大于2。
|
|||
|
|
- **ValueError** - 如果 `fweights` 的维度大于1。
|
|||
|
|
- **ValueError** - 如果 `fweights` 的numel不等于输入 `x` 的列数。
|
|||
|
|
- **ValueError** - 如果 `aweights` 的numel不等于输入 `x` 的列数。
|
|||
|
|
- **ValueError** - 如果 `aweights` 的维度大于1。
|
|||
|
|
- **TypeError** - 如果输入的类型为bool类型。
|
|||
|
|
- **TypeError** - 如果 `fweights` 的类型不为int。
|
|||
|
|
- **TypeError** - 如果 `aweights` 的类型不为浮点类型。
|