numpy.quantile#

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

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

版本 1.15.0 中的新增功能。

参数:
a实数的数组类

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

q浮点数的数组类

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

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

计算分位数的轴或轴。默认情况下,沿数组的扁平化版本计算分位数。

outndarray, 可选

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

overwrite_inputbool, 可选

如果为 True,则允许输入数组 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. ‘median_unbiased’

  9. ‘normal_unbiased’

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

  • ‘lower’

  • ‘higher’,

  • ‘midpoint’

  • ‘nearest’

有关详细信息,请参见注释。

版本 1.22.0 中的变更: 此参数以前称为“interpolation”,并且仅提供“linear”默认值和最后四个选项。

keepdimsbool, 可选

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

weights数组类, 可选

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

版本 2.0.0 中的新增功能。

interpolationstr, 可选

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

从版本 1.22.0 开始弃用。

返回值:
quantile标量或 ndarray

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

另请参见

mean
percentile

等效于 quantile,但 q 在 [0, 100] 范围内。

median

等效于 quantile(..., 0.5)

nanquantile

注释

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

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

(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 参数选择首选约定

方法

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

加权分位数:更正式地说,具有概率测度 \(P\) 的累积分布函数 \(F(y)=P(Y \leq y)\) 的概率级别 \(q\) 处的分位数被定义为满足 *覆盖条件* 的任何数字 \(x\)

\[P(Y < x) \leq q \quad\text{and}\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 和 Y. Fan,“统计软件包中的样本分位数”,美国统计学家,50(4),第 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 以了解大多数方法的可视化。