torch.gradient

torch.gradient(input, *, spacing=1, dim=None, edge_order=1) → List of Tensors

Оценивает градиент функции $g : \mathbb{R}^n \rightarrow \mathbb{R}$ в одной или нескольких размерностях с использованием метода центральных разностей второго порядка.

Градиент $g$ оценивается с помощью выборок. По умолчанию, когда spacing не указан, выборки полностью описываются input, а отображение входных координат на выход — такое же, как и отображение индексов тензора на значения. Например, для трёхмерного input описываемая функция — $g : \mathbb{R}^3 \rightarrow \mathbb{R}$, и $g(1, 2, 3)\ == input[1, 2, 3]$.

Когда spacing указан, он изменяет соотношение между input и входными координатами. Это подробно описано в разделе «Ключевые аргументы» ниже.

Градиент оценивается путём независимой оценки каждой частной производной $g$. Эта оценка точна, если $g$ принадлежит $C^3$ (имеет не менее 3 непрерывных производных), и оценку можно улучшить, предоставив более близкие выборки. Математически значение в каждой внутренней точке частной производной оценивается с использованием теоремы Тейлора с остатком.

$$\begin{aligned} f(x+h_r) = f(x) + h_r f'(x) + {h_r}^2 \frac{f''(x)}{2} + {h_r}^3 \frac{f'''(x_r)}{6} \\ \end{aligned}$$

где $x_r$ — число в интервале $[x, x+ h_r]$ и используя тот факт, что $f \in C^3$ мы получаем:

$$f'(x) \approx \frac{ {h_l}^2 f(x+h_r) - {h_r}^2 f(x-h_l) + ({h_r}^2-{h_l}^2 ) f(x) }{ {h_r} {h_l}^2 + {h_r}^2 {h_l} }$$

Примечание

Мы оцениваем градиент функций в комплексной области $g : \mathbb{C}^n \rightarrow \mathbb{C}$ аналогичным образом.

Значение каждой частной производной в граничных точках вычисляется по-другому. См. edge_order ниже.

Параметры:

input (Tensor) — тензор, представляющий значения функции

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

• spacing (scalar, list of scalar, list of Tensor, необязательно) — spacing может быть использован для изменения того, как input индексы тензора соотносятся с координатами выборок. Если spacing — скаляр, то индексы умножаются на скаляр для получения координат. Например, если spacing=2 индексы (1, 2, 3) преобразуются в координаты (2, 4, 6). Если spacing — список скаляров, то соответствующие индексы умножаются. Например, если spacing=(2, -1, 3) индексы (1, 2, 3) преобразуются в координаты (2, -2, 9). Наконец, если spacing — список одномерных тензоров, то каждый тензор определяет координаты для соответствующего измерения. Например, если индексы — (1, 2, 3), а тензоры — (t0, t1, t2), то координаты — (t0[1], t1[2], t2[3])
• dim (int, list of int, необязательно) — измерение или измерения для приближения градиента. По умолчанию вычисляется частный градиент по каждому измерению. Обратите внимание, что если dim указан, элементы аргумента spacing должны соответствовать указанным измерениям.
• edge_order (int, необязательно) — 1 или 2, для оценки граничных значений с помощью метода первого или второго порядка соответственно.

Примеры:

>>> # Estimates the gradient of f(x)=x^2 at points [-2, -1, 2, 4]
>>> coordinates = (torch.tensor([-2., -1., 1., 4.]),)
>>> values = torch.tensor([4., 1., 1., 16.], )
>>> torch.gradient(values, spacing = coordinates)
(tensor([-3., -2., 2., 5.]),)

>>> # Estimates the gradient of the R^2 -> R function whose samples are
>>> # described by the tensor t. Implicit coordinates are [0, 1] for the outermost
>>> # dimension and [0, 1, 2, 3] for the innermost dimension, and function estimates
>>> # partial derivative for both dimensions.
>>> t = torch.tensor([[1, 2, 4, 8], [10, 20, 40, 80]])
>>> torch.gradient(t)
(tensor([[ 9., 18., 36., 72.],
         [ 9., 18., 36., 72.]]),
 tensor([[ 1.0000, 1.5000, 3.0000, 4.0000],
         [10.0000, 15.0000, 30.0000, 40.0000]]))

>>> # A scalar value for spacing modifies the relationship between tensor indices
>>> # and input coordinates by multiplying the indices to find the
>>> # coordinates. For example, below the indices of the innermost
>>> # 0, 1, 2, 3 translate to coordinates of [0, 2, 4, 6], and the indices of
>>> # the outermost dimension 0, 1 translate to coordinates of [0, 2].
>>> torch.gradient(t, spacing = 2.0) # dim = None (implicitly [0, 1])
(tensor([[ 4.5000, 9.0000, 18.0000, 36.0000],
          [ 4.5000, 9.0000, 18.0000, 36.0000]]),
 tensor([[ 0.5000, 0.7500, 1.5000, 2.0000],
          [ 5.0000, 7.5000, 15.0000, 20.0000]]))
>>> # doubling the spacing between samples halves the estimated partial gradients.

>>>
>>> # Estimates only the partial derivative for dimension 1
>>> torch.gradient(t, dim = 1) # spacing = None (implicitly 1.)
(tensor([[ 1.0000, 1.5000, 3.0000, 4.0000],
         [10.0000, 15.0000, 30.0000, 40.0000]]),)

>>> # When spacing is a list of scalars, the relationship between the tensor
>>> # indices and input coordinates changes based on dimension.
>>> # For example, below, the indices of the innermost dimension 0, 1, 2, 3 translate
>>> # to coordinates of [0, 3, 6, 9], and the indices of the outermost dimension
>>> # 0, 1 translate to coordinates of [0, 2].
>>> torch.gradient(t, spacing = [3., 2.])
(tensor([[ 4.5000, 9.0000, 18.0000, 36.0000],
         [ 4.5000, 9.0000, 18.0000, 36.0000]]),
 tensor([[ 0.3333, 0.5000, 1.0000, 1.3333],
         [ 3.3333, 5.0000, 10.0000, 13.3333]]))

>>> # The following example is a replication of the previous one with explicit
>>> # coordinates.
>>> coords = (torch.tensor([0, 2]), torch.tensor([0, 3, 6, 9]))
>>> torch.gradient(t, spacing = coords)
(tensor([[ 4.5000, 9.0000, 18.0000, 36.0000],
         [ 4.5000, 9.0000, 18.0000, 36.0000]]),
 tensor([[ 0.3333, 0.5000, 1.0000, 1.3333],
         [ 3.3333, 5.0000, 10.0000, 13.3333]]))