numpy.quantile#

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

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

参数:
a实数的类数组对象

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

q浮点数数组类

分位数的概率或概率序列。值必须在 0 到 1 之间（包含边界）。

axis{int, tuple of int, None}, optional

计算分位数的轴或多个轴。默认计算扁平化数组的分位数。

outndarray，可选

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

overwrite_input布尔值，可选

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

method字符串，可选

此参数指定用于估计分位数的方法。存在多种不同的方法，其中一些是 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` 正确广播。

weightsarray_like, optional

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

版本 2.0.0 中新增。

返回:
quantile标量或 ndarray

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

另请参阅

mean
percentile

等同于 quantile，但 q 的范围为 [0, 100]。

median

等同于 quantile(..., 0.5)

nanquantile

备注

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

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

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

其中索引 j 和系数 g 分别是 q * (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

韦布尔

6

q

linear (默认)

7

1 - q

median_unbiased

8

q/3 + 1/3

normal_unbiased

9

q/4 + 3/8

注意，当公式的结果超出允许的非负索引范围时，索引 j 和 j + 1 会被截断到 0 到 n - 1 的范围内。j 和 g 公式中的 - 1 是为了兼容 Python 的 0 基索引。

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

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

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

  3. closest_observation: m = -1/2 且 g = 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_cdf 和 averaged_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，“Sample quantiles in statistical packages”，The American Statistician，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 以获取大多数方法的可视化。

在此页面