numpy.quantile#

numpy.quantile(a, q, axis=None, out=None, overwrite_input=False, method='linear', keepdims=False, *, weights=None, interpolation=None)[源代码]#

计算数据沿指定轴的 q 分位数。

参数:
a实数数组

可转换为数组的输入数组或对象。

q浮点数数组

要计算的分位数的概率或概率序列。值必须介于 0 和 1 之间(含)。

axis{int, int 元组, None},可选

计算分位数所沿的轴。默认情况下,沿数组的展平版本计算分位数。

outndarray,可选

用于放置结果的备用输出数组。它必须与预期输出具有相同的形状和缓冲区长度,但必要时会进行类型(输出类型)转换。

overwrite_inputbool,可选

如果为 True,则允许输入数组 a 被中间计算修改,以节省内存。在这种情况下,此函数完成后,输入 a 的内容是未定义的。

methodstr,可选此参数指定用于估计分位数的方法。有许多不同的方法,其中一些是 NumPy 特有的。建议的选项,按其在 [1] 中出现的顺序编号,包括:

‘inverted_cdf’

  1. ‘averaged_inverted_cdf’

  2. ‘closest_observation’

  3. ‘interpolated_inverted_cdf’

  4. ‘hazen’

  5. ‘weibull’

  6. ‘linear’ (默认)

  7. ‘median_unbiased’

  8. ‘normal_unbiased’

  9. 前三种方法是不连续的。为了与 NumPy 以前的版本保持向后兼容性,提供了默认 ‘linear’ (7.) 选项的以下不连续变体:

‘lower’

  • ‘higher’

  • ‘midpoint’

  • ‘nearest’

  • 详见备注。

1.22.0 版更改:此参数以前称为“interpolation”,仅提供“linear”默认选项和最后四个选项。

keepdimsbool,可选

如果设置为 True,则被缩减的轴将作为大小为一的维度保留在结果中。使用此选项,结果将与原始数组 a 正确广播。

weights数组,可选

a 中的值相关联的权重数组。a 中的每个值都根据其关联的权重对分位数做出贡献。权重数组可以是 1-D 的(在这种情况下,其长度必须与给定轴上 a 的大小相同),也可以与 a 具有相同的形状。如果 weights=None,则假定 a 中的所有数据权重都为一。只有 method=”inverted_cdf” 支持权重。详见备注。

2.0.0 版新增。

interpolationstr,可选

method 关键字参数的已弃用名称。

自 1.22.0 版起弃用。

返回:

quantile标量或 ndarray
如果 q 是单个概率且 axis=None,则结果为标量。如果给出多个概率级别,则结果的第一个轴对应于分位数。其他轴是 a 缩减后保留的轴。如果输入包含小于 float64 的整数或浮点数,则输出数据类型为 float64。否则,输出数据类型与输入的数据类型相同。如果指定了 out,则返回该数组。

另请参阅

给定来自基础分布的样本 aquantile 提供了逆累积分布函数的非参数估计。

默认情况下,通过在 ya 的排序副本)的相邻元素之间进行插值来完成此操作

其中索引 j 和系数 gq * (n-1) 的整数和小数部分,n 是样本中的元素数量。

(1-g)*y[j] + g*y[j+1]

这是 H&F [1] 中公式 1 的一个特例。更一般地,

j = (q*n + m - 1) // 1, 以及

  • g = (q*n + m - 1) % 1

  • 其中 m 可以根据几种不同的约定来定义。首选约定可以使用 method 参数选择,

方法

H&F 中的编号

m

interpolated_inverted_cdf

hazen

4

0

weibull

5

1/2

q

6

linear (默认)

1 - q

7

median_unbiased

q/3 + 1/3

8

normal_unbiased

q/4 + 3/8

9

请注意,当公式结果超出允许的非负索引范围时,索引 jj + 1 会被裁剪到 0n - 1 的范围内。- 1jg 的公式中是为了考虑 Python 的 0-基于索引。

上表仅包含 H&F 中作为概率 q 的连续函数(估计器 4-9)的估计器。NumPy 还提供了 H&F 中的三个不连续估计器(估计器 1-3),其中 j 如上所述定义,m 定义如下,g 是实值 index = q*n + m - 1j 的函数。

inverted_cdf: m = 0g = int(index - j > 0)

  1. averaged_inverted_cdf: m = 0g = (1 + int(index - j > 0)) / 2

  2. closest_observation: m = -1/2g = 1 - int((index == j) & (j%2 == 1))

  3. 为了与 NumPy 以前的版本保持向后兼容性,quantile 提供了另外四种不连续估计器。与 method='linear' 类似,所有估计器都有 m = 1 - q,因此 j = q*(n-1) // 1,但 g 定义如下。

lower: g = 0

  • midpoint: g = 0.5

  • higher: g = 1

  • nearest: g = (q*(n-1) % 1) > 0.5

  • 加权分位数:更正式地,在概率水平 \(q\) 上,累积分布函数 \(F(y)=P(Y \leq y)\)(具有概率测度 \(P\))的分位数定义为满足覆盖条件的任何数 \(x\)

\[P(Y < x) \leq q \quad\text{且}\quad P(Y \leq x) \geq q\]

其中随机变量 \(Y\sim P\)。样本分位数,即 quantile 的结果,在给定长度为 n 的数据向量 a 的情况下,提供了基础总体对应项(由未知 \(F\) 表示)的非参数估计。

当我们我们将 \(F\) 视为数据的经验分布函数时,即 \(F(y) = \frac{1}{n} \sum_i 1_{a_i \leq y}\),则会出现上述一些估计器。然后,不同的方法对应于满足上述覆盖条件的 \(x\) 的不同选择。遵循此方法的是 inverted_cdfaveraged_inverted_cdf

对于加权分位数,覆盖条件仍然成立。经验累积分布函数简单地被其加权版本取代,即 \(P(Y \leq t) = \frac{1}{\sum_i w_i} \sum_i w_i 1_{x_i \leq t}\)。只有 method="inverted_cdf" 支持权重。

参考文献

R. J. Hyndman and Y. Fan, “Sample quantiles in statistical packages,” The American Statistician, 50(4), pp. 361-365, 1996

[1] (1,2)

示例

在浏览器中尝试!

>>> import numpy as np
>>> a = np.array([[10, 7, 4], [3, 2, 1]])
>>> a
array([[10,  7,  4],
       [ 3,  2,  1]])
>>> np.quantile(a, 0.5)
3.5
>>> np.quantile(a, 0.5, axis=0)
array([6.5, 4.5, 2.5])
>>> np.quantile(a, 0.5, axis=1)
array([7.,  2.])
>>> np.quantile(a, 0.5, axis=1, keepdims=True)
array([[7.],
       [2.]])
>>> m = np.quantile(a, 0.5, axis=0)
>>> out = np.zeros_like(m)
>>> np.quantile(a, 0.5, axis=0, out=out)
array([6.5, 4.5, 2.5])
>>> m
array([6.5, 4.5, 2.5])
>>> b = a.copy()
>>> np.quantile(b, 0.5, axis=1, overwrite_input=True)
array([7.,  2.])
>>> assert not np.all(a == b)

返回

在此页上