torch.quantile

torch.quantile(input, q, dim=None, keepdim=False, *, interpolation='linear', out=None) → Tensor

计算 input 张量沿 dim 维度的每行的 q 分位数。

为了计算分位数，我们将 q 值在 [0, 1] 的范围内映射到索引范围 [0, n]，以找到已排序输入中分位数的位置。如果分位数位于已排序顺序中的索引 i 和 j 之间的两个数据点 a < b 之间，则根据给定的 interpolation 方法计算结果，如下所示：

• linear: a + (b - a) * fraction，其中 fraction 是计算出的分位数索引的小数部分。

• lower: a。

• higher: b。

• nearest: a 或 b，取决于哪个索引更接近计算出的分位数索引（.5 分数向下取整）。

• midpoint: (a + b) / 2。

如果 q 是一个 1D 张量，输出的第一维表示分位数，其大小等于 q 的大小，其余维度是归约后剩余的维度。

注意

默认情况下，dim 为 None，这会导致在计算之前将 input 张量展平。

参数

• input (Tensor) – 输入张量。

• q (float 或 Tensor) – 范围为 [0, 1] 的标量或 1D 张量。

• dim (int, 可选) – 要归约的维度。

• keepdim (bool, optional) – 输出张量是否保留 dim。默认为 False。

关键字参数

• interpolation (str, 可选) – 当期望分位数位于两个数据点之间时使用的插值方法。可以是 linear、lower、higher、midpoint 和 nearest。默认值为 linear。

• out (Tensor, optional) – 输出张量。

示例

>>> a = torch.randn(2, 3)
>>> a
tensor([[ 0.0795, -1.2117,  0.9765],
        [ 1.1707,  0.6706,  0.4884]])
>>> q = torch.tensor([0.25, 0.5, 0.75])
>>> torch.quantile(a, q, dim=1, keepdim=True)
tensor([[[-0.5661],
        [ 0.5795]],

        [[ 0.0795],
        [ 0.6706]],

        [[ 0.5280],
        [ 0.9206]]])
>>> torch.quantile(a, q, dim=1, keepdim=True).shape
torch.Size([3, 2, 1])
>>> a = torch.arange(4.)
>>> a
tensor([0., 1., 2., 3.])
>>> torch.quantile(a, 0.6, interpolation='linear')
tensor(1.8000)
>>> torch.quantile(a, 0.6, interpolation='lower')
tensor(1.)
>>> torch.quantile(a, 0.6, interpolation='higher')
tensor(2.)
>>> torch.quantile(a, 0.6, interpolation='midpoint')
tensor(1.5000)
>>> torch.quantile(a, 0.6, interpolation='nearest')
tensor(2.)
>>> torch.quantile(a, 0.4, interpolation='nearest')
tensor(1.)