torch.special

torch.special 模組，仿效 SciPy 的 special 模組。

函式

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

艾里函數 $\text{Ai}\left(\text{input}\right)$。

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

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

第一類零階貝索函數。

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

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

第一類一階貝索函數。

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

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

參數

input (Tensor) – 要計算 digamma 函數的張量

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

注意

此函數類似於 SciPy 的 scipy.special.digamma。

注意

從 PyTorch 1.8 開始，digamma 函數對 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, optional) – 輸出張量 (可選)。

範例：

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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（也稱為 logistic sigmoid 函數）。

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

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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 (Tensor) – 第一個非負輸入張量

• other (Tensor) – 第二個非負輸入張量

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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 (Tensor) – 第一個非負輸入張量

• other (Tensor) – 第二個非負輸入張量

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例

>>> 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 (Tensor) – 輸入張量 (the input tensor)

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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 的每個元素，計算第一類指數縮放的零階修正貝索函數（定義如下）。(Computes the exponentially scaled zeroth order modified Bessel function of the first kind (as defined below) for each element of 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, optional) – 輸出張量 (可選)。

範例：

>>> 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, optional) – 輸出張量 (可選)。

範例：

>>> 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, optional) – 輸出張量 (可選)。

範例：

>>> 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, optional) – 輸出張量 (可選)。

範例：

>>> 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 ( Tensor) – 輸入張量。

• dim ( int) – 計算 log_softmax 的維度。

• dtype ( torch.dtype, optional) – 返回張量所需的数据类型。如果指定，输入张量会在执行操作前转换为 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, optional) – 輸入鉗制邊界的 epsilon。 預設值：None

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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(-)$ 為 Gamma 函數。

所有元素都必須大於 $\frac{p - 1}{2}$，否則行為將會是未定義。

參數

• 輸入 (Tensor) – 用於計算多元 log-gamma 函數的張量

• p (int) – 維度數量

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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, optional) – 輸出張量 (可選)。

範例：

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

計算高斯機率密度函數下方的面積等於 input 的引數 x，針對每個元素進行計算（從負無限大積分到 x）。

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

注意

也稱為常態分佈的分位數函數。

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例：

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

計算 $n^{th}$ 輸入值 ( input ) 的 digamma 函數的 $n^{th}$ 階導數。$n \geq 0$ 被稱為 polygamma 函數的階數。

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

注意

此函數僅適用於非負整數 $n \geq 0$。

參數

• n (int) – polygamma 函數的階數

• input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例：

>>> 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, optional) – 輸出張量 (可選)。

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

第二類修正貝索函數，比例縮放版，階數為 $1$。

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

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

計算 input 的正規化 sinc 函數。

$$\text{out}_{i} = \begin{cases} 1, & \text{if}\ \text{input}_{i}=0 \\ \sin(\pi \text{input}_{i}) / (\pi \text{input}_{i}), & \text{otherwise} \end{cases}$$

參數

input (Tensor) – 輸入張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例：

>>> 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 ( Tensor) – 輸入張量。

• dim (int) – 計算 softmax 的維度。

• dtype ( torch.dtype, optional) – 返回張量所需的数据类型。如果指定，输入张量会在执行操作前转换为 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, optional) – 輸出張量 (可選)。

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

計算 input * log1p(other)，具有以下情況。

$$\text{out}_{i} = \begin{cases} \text{NaN} & \text{if } \text{other}_{i} = \text{NaN} \\ 0 & \text{if } \text{input}_{i} = 0.0 \text{ and } \text{other}_{i} != \text{NaN} \\ \text{input}_{i} * \text{log1p}(\text{other}_{i})& \text{otherwise} \end{cases}$$

與 SciPy 的 scipy.special.xlog1py 類似。

參數

• input (數字 或 Tensor) – 乘數

• other (數字 或 Tensor) – 參數

注意

至少 input 或 other 其中之一必須是張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

>>> 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{if } \text{other}_{i} = \text{NaN} \\ 0 & \text{if } \text{input}_{i} = 0.0 \\ \text{input}_{i} * \log{(\text{other}_{i})} & \text{otherwise} \end{cases}$$

類似於 SciPy 的 scipy.special.xlogy。

參數

• input (數字 或 Tensor) – 乘數

• other (數字 或 Tensor) – 參數

注意

至少 input 或 other 其中之一必須是張量。

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例

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

逐個元素 (elementwise) 計算赫維茲 zeta 函數 (Hurwitz zeta function)。

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

參數

• input (Tensor) – 對應於 x 的輸入張量（Tensor）。

• other (Tensor) – 對應於 q 的輸入張量（Tensor）。

注意

黎曼 zeta 函數對應於 q = 1 的情況

關鍵字參數

out (Tensor, optional) – 輸出張量 (可選)。

範例：

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