torch.meshgrid

torch.meshgrid(*tensors, indexing=None)

根据 attr:tensors 中的一维输入创建坐标网格。

当你想在某个输入范围内可视化数据时，这很有用。请参阅下方绘图示例。

给定 $N$ 个一维张量 $T_0 \ldots T_{N-1}$ 作为输入，其对应大小分别为 $S_0 \ldots S_{N-1}$，这将创建 $N$ 个 N 维张量 $G_0 \ldots G_{N-1}$，每个张量的形状为 $(S_0, ..., S_{N-1})$，其中输出 $G_i$ 通过将 $T_i$ 扩展到结果形状来构建。

注意

0D 输入被视为具有单个元素的一维输入。

警告

torch.meshgrid(*tensors) 当前行为与调用 numpy.meshgrid(*arrays, indexing=’ij’) 相同。

将来，torch.meshgrid 将把 indexing=’xy’ 作为默认值。

https://github.com/pytorch/pytorch/issues/50276 跟踪此问题，目标是迁移到 NumPy 的行为。

另请参阅

torch.cartesian_prod() 效果相同，但它将数据收集在一个向量张量中。

参数

• tensors (list of Tensor) – 标量或一维张量列表。标量将自动被视为大小为 $(1,)$ 的张量

• indexing (Optional[str]) –

  (str，可选)：索引模式，可以是 “xy” 或 “ij”，默认为 “ij”。请参阅警告了解未来的更改。

  如果选择 “xy”，则第一个维度对应于第二个输入的基数，第二个维度对应于第一个输入的基数。

  如果选择 “ij”，则维度的顺序与输入的基数相同。

返回

如果输入包含 $N$ 个大小为 $S_0 \ldots S_{N-1}$ 的张量，则输出也将包含 $N$ 个张量，其中每个张量的形状为 $(S_0, ..., S_{N-1})$。

返回类型

seq (张量序列)

示例

>>> x = torch.tensor([1, 2, 3])
>>> y = torch.tensor([4, 5, 6])

Observe the element-wise pairings across the grid, (1, 4),
(1, 5), ..., (3, 6). This is the same thing as the
cartesian product.
>>> grid_x, grid_y = torch.meshgrid(x, y, indexing='ij')
>>> grid_x
tensor([[1, 1, 1],
        [2, 2, 2],
        [3, 3, 3]])
>>> grid_y
tensor([[4, 5, 6],
        [4, 5, 6],
        [4, 5, 6]])

This correspondence can be seen when these grids are
stacked properly.
>>> torch.equal(torch.cat(tuple(torch.dstack([grid_x, grid_y]))),
...             torch.cartesian_prod(x, y))
True

`torch.meshgrid` is commonly used to produce a grid for
plotting.
>>> import matplotlib.pyplot as plt
>>> xs = torch.linspace(-5, 5, steps=100)
>>> ys = torch.linspace(-5, 5, steps=100)
>>> x, y = torch.meshgrid(xs, ys, indexing='xy')
>>> z = torch.sin(torch.sqrt(x * x + y * y))
>>> ax = plt.axes(projection='3d')
>>> ax.plot_surface(x.numpy(), y.numpy(), z.numpy())
>>> plt.show()