torch.special

torch.special 模块，以 SciPy 的 special 模块为模型。

函数

torch.special.airy_ai(input, *, out=None) → Tensor

艾里函数 $\text{Ai}\left(\text{input}\right)$.

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

torch.special.bessel_j0(input, *, out=None) → Tensor

第一类 $0$ 阶贝塞尔函数。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

torch.special.bessel_j1(input, *, out=None) → Tensor

第一类 $1$ 阶贝塞尔函数。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

torch.special.digamma(input, *, out=None) → Tensor

计算 input 上伽马函数的对数导数。

$$\digamma(x) = \frac{d}{dx} \ln\left(\Gamma\left(x\right)\right) = \frac{\Gamma'(x)}{\Gamma(x)}$$

参数

输入 (张量) – 计算双伽马函数的张量

关键字参数

out (Tensor, 可选) – 输出张量。

注意

此函数类似于 SciPy 的 scipy.special.digamma。

注意

从 PyTorch 1.8 开始，双伽马函数对于 0 返回 -Inf。之前它对于 0 返回 NaN。

示例

>>> a = torch.tensor([1, 0.5])
>>> torch.special.digamma(a)
tensor([-0.5772, -1.9635])

torch.special.entr(input, *, out=None) → Tensor

逐元素计算 input 上的熵（如下所定义）。

$$\begin{align} \text{entr(x)} = \begin{cases} -x * \ln(x) & x > 0 \\ 0 & x = 0.0 \\ -\infty & x < 0 \end{cases} \end{align}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> a = torch.arange(-0.5, 1, 0.5)
>>> a
tensor([-0.5000,  0.0000,  0.5000])
>>> torch.special.entr(a)
tensor([  -inf, 0.0000, 0.3466])

torch.special.erf(input, *, out=None) → Tensor

计算 input 的误差函数。误差函数定义如下

$$\mathrm{erf}(x) = \frac{2}{\sqrt{\pi}} \int_{0}^{x} e^{-t^2} dt$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.special.erf(torch.tensor([0, -1., 10.]))
tensor([ 0.0000, -0.8427,  1.0000])

torch.special.erfc(input, *, out=None) → Tensor

计算 input 的互补误差函数。互补误差函数定义如下：

$$\mathrm{erfc}(x) = 1 - \frac{2}{\sqrt{\pi}} \int_{0}^{x} e^{-t^2} dt$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.special.erfc(torch.tensor([0, -1., 10.]))
tensor([ 1.0000, 1.8427,  0.0000])

torch.special.erfcx(input, *, out=None) → Tensor

计算 input 中每个元素的缩放互补误差函数。缩放互补误差函数定义如下：

$$\mathrm{erfcx}(x) = e^{x^2} \mathrm{erfc}(x)$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.special.erfcx(torch.tensor([0, -1., 10.]))
tensor([ 1.0000, 5.0090, 0.0561])

torch.special.erfinv(input, *, out=None) → Tensor

计算 input 的反误差函数。反误差函数在范围 $(-1, 1)$ 内定义为：

$$\mathrm{erfinv}(\mathrm{erf}(x)) = x$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.special.erfinv(torch.tensor([0, 0.5, -1.]))
tensor([ 0.0000,  0.4769,    -inf])

torch.special.exp2(input, *, out=None) → Tensor

计算input的以2为底的指数函数。

$$y_{i} = 2^{x_{i}}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.special.exp2(torch.tensor([0, math.log2(2.), 3, 4]))
tensor([ 1.,  2.,  8., 16.])

torch.special.expit(input, *, out=None) → Tensor

计算input元素的expit（也称为逻辑sigmoid函数）。

$$\text{out}_{i} = \frac{1}{1 + e^{-\text{input}_{i}}}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> t = torch.randn(4)
>>> t
tensor([ 0.9213,  1.0887, -0.8858, -1.7683])
>>> torch.special.expit(t)
tensor([ 0.7153,  0.7481,  0.2920,  0.1458])

torch.special.expm1(input, *, out=None) → Tensor

计算input元素的指数减1。

$$y_{i} = e^{x_{i}} - 1$$

注意

对于小的x值，此函数比exp(x) - 1提供更高的精度。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.special.expm1(torch.tensor([0, math.log(2.)]))
tensor([ 0.,  1.])

torch.special.gammainc(input, other, *, out=None) → Tensor

计算正则化下不完全伽马函数

$$\text{out}_{i} = \frac{1}{\Gamma(\text{input}_i)} \int_0^{\text{other}_i} t^{\text{input}_i-1} e^{-t} dt$$

当 $\text{input}_i$ 和 $\text{other}_i$ 均为弱正数，且至少一个为严格正数时。如果两者都为零或其中一个为负数，则 $\text{out}_i=\text{nan}$。上式中的 $\Gamma(\cdot)$ 是伽马函数，

$$\Gamma(\text{input}_i) = \int_0^\infty t^{(\text{input}_i-1)} e^{-t} dt.$$

有关函数，请参见 torch.special.gammaincc() 和 torch.special.gammaln()。

支持 广播到公共形状 和浮点输入。

注意

尚不支持关于 input 的反向传播。请在 PyTorch 的 Github 上提交 issue 以请求此功能。

参数

• **input** (张量) – 第一个非负输入张量

• **other** (张量) – 第二个非负输入张量

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> a1 = torch.tensor([4.0])
>>> a2 = torch.tensor([3.0, 4.0, 5.0])
>>> a = torch.special.gammaincc(a1, a2)
tensor([0.3528, 0.5665, 0.7350])
tensor([0.3528, 0.5665, 0.7350])
>>> b = torch.special.gammainc(a1, a2) + torch.special.gammaincc(a1, a2)
tensor([1., 1., 1.])

torch.special.gammaincc(input, other, *, out=None) → Tensor

计算正则化上不完全伽马函数

$$\text{out}_{i} = \frac{1}{\Gamma(\text{input}_i)} \int_{\text{other}_i}^{\infty} t^{\text{input}_i-1} e^{-t} dt$$

当 $\text{input}_i$ 和 $\text{other}_i$ 均为弱正数，且至少一个为严格正数时。如果两者都为零或其中一个为负数，则 $\text{out}_i=\text{nan}$。上式中的 $\Gamma(\cdot)$ 是伽马函数，

$$\Gamma(\text{input}_i) = \int_0^\infty t^{(\text{input}_i-1)} e^{-t} dt.$$

有关函数，请参见 torch.special.gammainc() 和 torch.special.gammaln()。

支持 广播到公共形状 和浮点输入。

注意

尚不支持关于 input 的反向传播。请在 PyTorch 的 Github 上提交 issue 以请求此功能。

参数

• **input** (张量) – 第一个非负输入张量

• **other** (张量) – 第二个非负输入张量

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> a1 = torch.tensor([4.0])
>>> a2 = torch.tensor([3.0, 4.0, 5.0])
>>> a = torch.special.gammaincc(a1, a2)
tensor([0.6472, 0.4335, 0.2650])
>>> b = torch.special.gammainc(a1, a2) + torch.special.gammaincc(a1, a2)
tensor([1., 1., 1.])

torch.special.gammaln(input, *, out=None) → Tensor

计算 input 上伽马函数绝对值的自然对数。

$$\text{out}_{i} = \ln \Gamma(|\text{input}_{i}|)$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> a = torch.arange(0.5, 2, 0.5)
>>> torch.special.gammaln(a)
tensor([ 0.5724,  0.0000, -0.1208])

torch.special.i0(input, *, out=None) → Tensor

计算input中每个元素的第一类零阶修正贝塞尔函数。

$$\text{out}_{i} = I_0(\text{input}_{i}) = \sum_{k=0}^{\infty} \frac{(\text{input}_{i}^2/4)^k}{(k!)^2}$$

参数

input (张量) – 输入张量

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> torch.i0(torch.arange(5, dtype=torch.float32))
tensor([ 1.0000,  1.2661,  2.2796,  4.8808, 11.3019])

torch.special.i0e(input, *, out=None) → Tensor

计算input中每个元素的第一类零阶修正贝塞尔函数的指数缩放值（如下定义）。

$$\text{out}_{i} = \exp(-|x|) * i0(x) = \exp(-|x|) * \sum_{k=0}^{\infty} \frac{(\text{input}_{i}^2/4)^k}{(k!)^2}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> torch.special.i0e(torch.arange(5, dtype=torch.float32))
tensor([1.0000, 0.4658, 0.3085, 0.2430, 0.2070])

torch.special.i1(input, *, out=None) → Tensor

计算input中每个元素的一阶修正贝塞尔函数（如下定义）。

$$\text{out}_{i} = \frac{(\text{input}_{i})}{2} * \sum_{k=0}^{\infty} \frac{(\text{input}_{i}^2/4)^k}{(k!) * (k+1)!}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> torch.special.i1(torch.arange(5, dtype=torch.float32))
tensor([0.0000, 0.5652, 1.5906, 3.9534, 9.7595])

torch.special.i1e(input, *, out=None) → Tensor

计算input中每个元素的指数缩放的一阶修正贝塞尔函数（如下定义）。

$$\text{out}_{i} = \exp(-|x|) * i1(x) = \exp(-|x|) * \frac{(\text{input}_{i})}{2} * \sum_{k=0}^{\infty} \frac{(\text{input}_{i}^2/4)^k}{(k!) * (k+1)!}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> torch.special.i1e(torch.arange(5, dtype=torch.float32))
tensor([0.0000, 0.2079, 0.2153, 0.1968, 0.1788])

torch.special.log1p(input, *, out=None) → Tensor

torch.log1p() 的别名。

torch.special.log_ndtr(input, *, out=None) → Tensor

逐元素计算标准高斯概率密度函数从负无穷到 input 的积分区域的对数。

$$\text{log\_ndtr}(x) = \log\left(\frac{1}{\sqrt{2 \pi}}\int_{-\infty}^{x} e^{-\frac{1}{2}t^2} dt \right)$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> torch.special.log_ndtr(torch.tensor([-3., -2, -1, 0, 1, 2, 3]))
tensor([-6.6077 -3.7832 -1.841  -0.6931 -0.1728 -0.023  -0.0014])

torch.special.log_softmax(input, dim, *, dtype=None) → Tensor

计算 softmax 然后取对数。

虽然在数学上等价于 log(softmax(x))，但单独执行这两个操作速度较慢且数值不稳定。此函数计算如下：

$$\text{log\_softmax}(x_{i}) = \log\left(\frac{\exp(x_i) }{ \sum_j \exp(x_j)} \right)$$

参数

• input (张量) – 输入

• dim (整数) – 将计算 log_softmax 的维度。

• dtype (torch.dtype，可选) – 返回张量的所需数据类型。如果指定，则在执行操作之前将输入张量转换为 dtype。这有助于防止数据类型溢出。默认值：None。

示例：

>>> t = torch.ones(2, 2)
>>> torch.special.log_softmax(t, 0)
tensor([[-0.6931, -0.6931],
        [-0.6931, -0.6931]])

torch.special.logit(input, eps=None, *, out=None) → Tensor

返回一个新的张量，其中包含 input 元素的 logit。当 eps 不为 None 时，input 将被限制在 [eps, 1 - eps] 范围内。当 eps 为 None 且 input < 0 或 input > 1 时，函数将返回 NaN。

$$\begin{align} y_{i} &= \ln(\frac{z_{i}}{1 - z_{i}}) \\ z_{i} &= \begin{cases} x_{i} & \text{if eps is None} \\ \text{eps} & \text{if } x_{i} < \text{eps} \\ x_{i} & \text{if } \text{eps} \leq x_{i} \leq 1 - \text{eps} \\ 1 - \text{eps} & \text{if } x_{i} > 1 - \text{eps} \end{cases} \end{align}$$

参数

• input (Tensor) – 输入张量。

• eps (float, 可选) – 输入钳位边界的epsilon。默认值：None

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> a = torch.rand(5)
>>> a
tensor([0.2796, 0.9331, 0.6486, 0.1523, 0.6516])
>>> torch.special.logit(a, eps=1e-6)
tensor([-0.9466,  2.6352,  0.6131, -1.7169,  0.6261])

torch.special.logsumexp(input, dim, keepdim=False, *, out=None)

torch.logsumexp() 的别名。

torch.special.multigammaln(input, p, *, out=None) → Tensor

计算维度为 $p$ 的 多元对数伽马函数 的逐元素值，由下式给出

$$\log(\Gamma_{p}(a)) = C + \displaystyle \sum_{i=1}^{p} \log\left(\Gamma\left(a - \frac{i - 1}{2}\right)\right)$$

其中 $C = \log(\pi) \cdot \frac{p (p - 1)}{4}$ 且 $\Gamma(-)$ 是伽马函数。

所有元素必须大于 $\frac{p - 1}{2}$，否则行为未定义。

参数

• 输入 (张量) – 计算多元对数伽马函数的张量

• p (整数) – 维数

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> a = torch.empty(2, 3).uniform_(1, 2)
>>> a
tensor([[1.6835, 1.8474, 1.1929],
        [1.0475, 1.7162, 1.4180]])
>>> torch.special.multigammaln(a, 2)
tensor([[0.3928, 0.4007, 0.7586],
        [1.0311, 0.3901, 0.5049]])

torch.special.ndtr(input, *, out=None) → Tensor

逐元素计算标准高斯概率密度函数从负无穷到input的积分。

$$\text{ndtr}(x) = \frac{1}{\sqrt{2 \pi}}\int_{-\infty}^{x} e^{-\frac{1}{2}t^2} dt$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> torch.special.ndtr(torch.tensor([-3., -2, -1, 0, 1, 2, 3]))
tensor([0.0013, 0.0228, 0.1587, 0.5000, 0.8413, 0.9772, 0.9987])

torch.special.ndtri(input, *, out=None) → Tensor

逐元素计算高斯概率密度函数下，从负无穷到 x 的积分面积等于 input 的参数 x。

$$\text{ndtri}(p) = \sqrt{2}\text{erf}^{-1}(2p - 1)$$

注意

也称为正态分布的分位数函数。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> torch.special.ndtri(torch.tensor([0, 0.25, 0.5, 0.75, 1]))
tensor([   -inf, -0.6745,  0.0000,  0.6745,     inf])

torch.special.polygamma(n, input, *, out=None) → Tensor

计算 input 上的双伽马函数的第 $n^{th}$ 阶导数。 $n \geq 0$ 称为双伽马函数的阶数。

$$\psi^{(n)}(x) = \frac{d^{(n)}}{dx^{(n)}} \psi(x)$$

注意

此函数仅针对非负整数 $n \geq 0$ 实现。

参数

• n (int) – 双伽马函数的阶数

• input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> a = torch.tensor([1, 0.5])
>>> torch.special.polygamma(1, a)
tensor([1.64493, 4.9348])
>>> torch.special.polygamma(2, a)
tensor([ -2.4041, -16.8288])
>>> torch.special.polygamma(3, a)
tensor([ 6.4939, 97.4091])
>>> torch.special.polygamma(4, a)
tensor([ -24.8863, -771.4742])

torch.special.psi(input, *, out=None) → Tensor

torch.special.digamma() 的别名。

torch.special.round(input, *, out=None) → Tensor

torch.round() 的别名。

torch.special.scaled_modified_bessel_k0(input, *, out=None) → Tensor

阶数为 $0$ 的二类修正贝塞尔函数的缩放版本。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

torch.special.scaled_modified_bessel_k1(input, *, out=None) → Tensor

阶数为 $1$ 的二类修正贝塞尔函数的缩放版本。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

torch.special.sinc(input, *, out=None) → Tensor

计算 input 的归一化 sinc 函数。

$$\text{out}_{i} = \begin{cases} 1, & \text{如果}\ \text{input}_{i}=0 \\ \sin(\pi \text{input}_{i}) / (\pi \text{input}_{i}), & \text{否则} \end{cases}$$

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> t = torch.randn(4)
>>> t
tensor([ 0.2252, -0.2948,  1.0267, -1.1566])
>>> torch.special.sinc(t)
tensor([ 0.9186,  0.8631, -0.0259, -0.1300])

torch.special.softmax(input, dim, *, dtype=None) → Tensor

计算 softmax 函数。

Softmax 定义为

$\text{Softmax}(x_{i}) = \frac{\exp(x_i)}{\sum_j \exp(x_j)}$

它应用于沿 dim 的所有切片，并将重新缩放它们，以便元素位于范围 [0, 1] 内，并且总和为 1。

参数

• input (张量) – 输入

• dim (int) – 计算 softmax 的维度。

• dtype (torch.dtype，可选) – 返回张量的所需数据类型。如果指定，则在执行操作之前将输入张量转换为 dtype。这有助于防止数据类型溢出。默认值：None。

示例：

>>> t = torch.ones(2, 2)
>>> torch.special.softmax(t, 0)
tensor([[0.5000, 0.5000],
        [0.5000, 0.5000]])

torch.special.spherical_bessel_j0(input, *, out=None) → Tensor

阶为 $0$ 的第一类球贝塞尔函数。

参数

input (Tensor) – 输入张量。

关键字参数

out (Tensor, 可选) – 输出张量。

torch.special.xlog1py(input, other, *, out=None) → Tensor

计算 input * log1p(other)，包含以下情况。

$$\text{out}_{i} = \begin{cases} \text{NaN} & \text{如果 } \text{other}_{i} = \text{NaN} \\ 0 & \text{如果 } \text{input}_{i} = 0.0 \text{ 并且 } \text{other}_{i} != \text{NaN} \\ \text{input}_{i} * \text{log1p}(\text{other}_{i})& \text{否则} \end{cases}$$

类似于 SciPy 的 scipy.special.xlog1py。

参数

• input (数字 或 张量) – 乘数

• other (数字 或 张量) – 参数

注意

input 或 other 中至少有一个必须是张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> x = torch.zeros(5,)
>>> y = torch.tensor([-1, 0, 1, float('inf'), float('nan')])
>>> torch.special.xlog1py(x, y)
tensor([0., 0., 0., 0., nan])
>>> x = torch.tensor([1, 2, 3])
>>> y = torch.tensor([3, 2, 1])
>>> torch.special.xlog1py(x, y)
tensor([1.3863, 2.1972, 2.0794])
>>> torch.special.xlog1py(x, 4)
tensor([1.6094, 3.2189, 4.8283])
>>> torch.special.xlog1py(2, y)
tensor([2.7726, 2.1972, 1.3863])

torch.special.xlogy(input, other, *, out=None) → Tensor

计算 input * log(other)，并包含以下情况。

$$\text{out}_{i} = \begin{cases} \text{NaN} & \text{如果 } \text{other}_{i} = \text{NaN} \\ 0 & \text{如果 } \text{input}_{i} = 0.0 \\ \text{input}_{i} * \log{(\text{other}_{i})} & \text{否则} \end{cases}$$

类似于 SciPy 的 scipy.special.xlogy。

参数

• input (数字 或 张量) – 乘数

• other (数字 或 张量) – 参数

注意

input 或 other 中至少有一个必须是张量。

关键字参数

out (Tensor, 可选) – 输出张量。

示例

>>> x = torch.zeros(5,)
>>> y = torch.tensor([-1, 0, 1, float('inf'), float('nan')])
>>> torch.special.xlogy(x, y)
tensor([0., 0., 0., 0., nan])
>>> x = torch.tensor([1, 2, 3])
>>> y = torch.tensor([3, 2, 1])
>>> torch.special.xlogy(x, y)
tensor([1.0986, 1.3863, 0.0000])
>>> torch.special.xlogy(x, 4)
tensor([1.3863, 2.7726, 4.1589])
>>> torch.special.xlogy(2, y)
tensor([2.1972, 1.3863, 0.0000])

torch.special.zeta(input, other, *, out=None) → Tensor

逐元素计算 Hurwitz zeta 函数。

$$\zeta(x, q) = \sum_{k=0}^{\infty} \frac{1}{(k + q)^x}$$

参数

• input (张量) – 对应于 x 的输入张量。

• other (张量) – 对应于 q 的输入张量。

注意

当 q = 1 时，对应于黎曼 zeta 函数。

关键字参数

out (Tensor, 可选) – 输出张量。

示例：

>>> x = torch.tensor([2., 4.])
>>> torch.special.zeta(x, 1)
tensor([1.6449, 1.0823])
>>> torch.special.zeta(x, torch.tensor([1., 2.]))
tensor([1.6449, 0.0823])
>>> torch.special.zeta(2, torch.tensor([1., 2.]))
tensor([1.6449, 0.6449])