numpy.quantile#

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

计算沿指定轴的数据的第 q 个分位数.

在 1.15.0 版本加入.

参数:
a类似数组的实数

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

q类似数组的浮点数

要计算的分位数的概率或概率序列.值必须在0到1之间(包括0和1).

axis{int, tuple of int, None}, 可选

计算分位数所沿的轴或轴.默认是计算数组展平版本上的分位数.

outndarray, 可选

要在其中放置结果的替代输出数组.它必须具有与预期输出相同的形状和缓冲区长度,但如果需要,输出类型将被强制转换.

overwrite_inputbool, 可选

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

methodstr, 可选

此参数指定用于估计分位数的方法.有许多不同的方法,其中一些是NumPy特有的.推荐的选项,编号与它们在 [1] 中出现的顺序相同,如下:

  1. ‘inverted_cdf’

  2. ‘averaged_inverted_cdf’

  3. ‘closest_observation’

  4. ‘interpolated_inverted_cdf’

  5. ‘hazen’

  6. ‘weibull’

  7. ‘linear’ (默认)

  8. ‘中位数无偏’

  9. ‘normal_unbiased’

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

  • ‘lower’

  • ‘更高’,

  • ‘中点’

  • ‘nearest’

详情请参见备注.

在 1.22.0 版本发生变更: 这个参数之前被称为”插值”,并且只提供”线性”默认值和最后四个选项.

keepdimsbool, 可选

如果设置为 True,被减少的轴将作为尺寸为1的维度保留在结果中.使用此选项,结果将正确地与原始数组 a 进行广播.

weightsarray_like, 可选

a 中值相关的一组权重.`a` 中的每个值根据其相关权重对分位数做出贡献.权重数组可以是 1-D(在这种情况下,其长度必须与 a 沿给定轴的大小相同)或与 a 的形状相同.如果 weights=None,则假定 a 中的所有数据具有等于一的权重.只有 method=”inverted_cdf” 支持权重.有关更多详细信息,请参见注释.

在 2.0.0 版本加入.

interpolationstr, 可选

该方法的关键字参数的弃用名称.

自 1.22.0 版本弃用.

返回:
quantile标量或ndarray

如果 q 是一个单一的概率并且 axis=None,那么结果是一个标量.如果给出了多个概率水平,结果的第一个轴对应于分位数.其他的轴是 a 减少后剩余的轴.如果输入包含小于 float64 的整数或浮点数,则输出数据类型是 float64.否则,输出数据类型与输入相同.如果指定了 out,则返回该数组.

参见

mean
percentile

等效于分位数,但 q 的范围在 [0, 100] 之间.

median

等同于 quantile(..., 0.5)

nanquantile

备注

给定来自潜在分布的样本 a,`quantile` 提供了一个非参数估计的逆累积分布函数.

默认情况下,这是通过在 y 中相邻元素之间进行插值来完成的,``y`` 是 a 的排序副本:

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

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

这是 H&F 的方程 1 的一个特殊情况 [1].更一般地,

  • j = (q*n + m - 1) // 1,并且

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

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

method

H&F中的数字

m

interpolated_inverted_cdf

4

0

hazen

5

1/2

weibull

6

q

linear (默认)

7

1 - q

median_unbiased

8

q/3 + 1/3

normal_unbiased

9

q/4 + 3/8

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

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

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

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

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

为了与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 的结果,提供了对基础总体分位数的非参数估计,这些总体分位数由未知的 \(F\) 表示,给定长度为 n 的数据向量 a.

上述估计量中的一些是在将 \(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" 支持权重.

参考文献

[1] (1,2)

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

示例

>>> 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)

另请参见 numpy.percentile 以了解大多数方法的可视化.