torch.special

Функции

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

Функция Эйри $\text{Ai}\left(\text{input}\right)$.

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

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

Функция Бесселя первого рода порядка $0$.

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

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

Функция Бесселя первого рода порядка $1$.

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

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 (Тензор) – тензор для вычисления функции дигаммы.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Примечание

Эта функция аналогична функции SciPy scipy.special.digamma.

Примечание

Начиная с PyTorch 1.8, функция дигаммы возвращает -Inf для 0. Раньше она возвращала NaN для 0.

Пример:

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример::

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

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

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

Вычисляет функцию экспоненты по основанию два для input.

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

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

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

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

Вычисляет expit (также известную как логистическую сигмоиду) элементов input.

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

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

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

Вычисляет экспоненту элементов минус 1 для input.

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

Примечание

Эта функция обеспечивает большую точность, чем exp(x) - 1 для малых значений x.

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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 пока не поддерживается. Пожалуйста, откройте вопрос на Github PyTorch, чтобы запросить это.

Parameters:

• input (Tensor) – первый неотрицательный входной тензор
• other (Tensor) – второй неотрицательный входной тензор

Keyword Arguments:

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

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

Вычисляет натуральный логарифм абсолютного значения гамма-функции по input.

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

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) – входной тензор

Аргументы по ключевым словам:

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. input ограничивается значениями от [eps, 1 - eps], когда eps не None. Когда 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 (Тензор) – входной тензор.
• eps (вещественное число, необязательно) – epsilon для ограничения ввода. По умолчанию: None

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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}$, в противном случае поведение не определено.

Параметры:

• input (Тензор) – тензор для вычисления многомерной логарифмической гамма-функции
• p (целое число) – число измерений

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример::

>>> 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, для которого площадь под кривой функции плотности гауссовой вероятности (интегрированная от минус бесконечности до x) равна input, поэлементно.

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

Примечание

Также известно как квантильная функция для нормального распределения.

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример::

>>> 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. $n \geq 0$ называется порядком полигаммы.

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

Примечание

Эта функция реализована только для неотрицательных целых чисел $n \geq 0$.

Параметры:

• n (целое) – порядок функции полигамма
• input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример::

>>> 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

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

Масштабированная модифицированная функция Бесселя второго рода порядка $1$.

Параметры:

input (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

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

Вычисляет нормированную функцию sinc от input.

$$\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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример::

>>> 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 (целое) – Измерение, по которому будет вычислена 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 (Тензор) – входной тензор.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

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's scipy.special.xlog1py.

Параметры:

• input (Число или Тензор) – Множитель
• other (Число или Тензор) – Аргумент

Примечание

По крайней мере один из input или other должен быть тензором.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

>>> 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’s scipy.special.xlogy.

Параметры:

• input (Число или Тензор) – Множитель
• other (Число или Тензор) – Аргумент

Примечание

По крайней мере один из input или other должен быть тензором.

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример:

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

Вычисляет дзета-функцию Хёрвита, поэлементно.

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

Параметры:

• input (Тензор) – входной тензор, соответствующий x.
• other (Тензор) – входной тензор, соответствующий q.

Примечание

Функция Римана дзета соответствует случаю, когда q = 1

Ключевые аргументы:

out (Тензор, необязательно) – выходной тензор.

Пример::

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