torch.Tensor.sparse_mask

Tensor.sparse_mask(mask) → Tensor

返回一个新的 稀疏张量，其中包含来自步长张量 self 的值，这些值通过稀疏张量 mask 的索引过滤。忽略 mask 稀疏张量的值。 self 和 mask 张量必须具有相同的形状。

注意

如果 mask 未合并，则返回的稀疏张量可能包含重复值。因此，建议传递 mask.coalesce()，除非需要这种行为。

注意

返回的稀疏张量具有与稀疏张量 mask 相同的索引，即使 self 中的对应值为零也是如此。

参数

mask (Tensor) – 索引用作过滤器的稀疏张量

示例

>>> nse = 5
>>> dims = (5, 5, 2, 2)
>>> I = torch.cat([torch.randint(0, dims[0], size=(nse,)),
...                torch.randint(0, dims[1], size=(nse,))], 0).reshape(2, nse)
>>> V = torch.randn(nse, dims[2], dims[3])
>>> S = torch.sparse_coo_tensor(I, V, dims).coalesce()
>>> D = torch.randn(dims)
>>> D.sparse_mask(S)
tensor(indices=tensor([[0, 0, 0, 2],
                       [0, 1, 4, 3]]),
       values=tensor([[[ 1.6550,  0.2397],
                       [-0.1611, -0.0779]],

                      [[ 0.2326, -1.0558],
                       [ 1.4711,  1.9678]],

                      [[-0.5138, -0.0411],
                       [ 1.9417,  0.5158]],

                      [[ 0.0793,  0.0036],
                       [-0.2569, -0.1055]]]),
       size=(5, 5, 2, 2), nnz=4, layout=torch.sparse_coo)