torch.sparse.sampled_addmm

torch.sparse.sampled_addmm(input, mat1, mat2, *, beta=1., alpha=1., out=None) → Tensor

根据 input 的稀疏模式指定的 位置，执行密集矩阵 mat1 和 mat2 的矩阵乘法。矩阵 input 将添加到最终结果中。

在数学上，此操作执行以下运算

$$\text{out} = \alpha\ (\text{mat1} \mathbin{@} \text{mat2})*\text{spy}(\text{input}) + \beta\ \text{input}$$

其中 $\text{spy}(\text{input})$ 是 input 的稀疏模式矩阵，alpha 和 beta 是缩放因子。 $\text{spy}(\text{input})$ 在 input 具有非零值的位置处值为 1，在其他位置处值为 0。

注意

input 必须是稀疏 CSR 张量。 mat1 和 mat2 必须是密集张量。

参数

• input (张量) – 形状为 (m, n) 的稀疏 CSR 矩阵，用于添加并计算采样矩阵乘法

• mat1 (张量) – 形状为 (m, k) 的密集矩阵，用于相乘

• mat2 (张量) – 形状为 (k, n) 的密集矩阵，用于相乘

关键字参数

• beta (数字, 可选) – input 的乘数 ($\beta$)

• alpha (数字, 可选) – $mat1 @ mat2$ 的乘数 ($\alpha$)

• out (张量, 可选) – 输出张量。如果为 None 则忽略。默认值： None。

示例

>>> input = torch.eye(3, device='cuda').to_sparse_csr()
>>> mat1 = torch.randn(3, 5, device='cuda')
>>> mat2 = torch.randn(5, 3, device='cuda')
>>> torch.sparse.sampled_addmm(input, mat1, mat2)
tensor(crow_indices=tensor([0, 1, 2, 3]),
    col_indices=tensor([0, 1, 2]),
    values=tensor([ 0.2847, -0.7805, -0.1900]), device='cuda:0',
    size=(3, 3), nnz=3, layout=torch.sparse_csr)
>>> torch.sparse.sampled_addmm(input, mat1, mat2).to_dense()
tensor([[ 0.2847,  0.0000,  0.0000],
    [ 0.0000, -0.7805,  0.0000],
    [ 0.0000,  0.0000, -0.1900]], device='cuda:0')
>>> torch.sparse.sampled_addmm(input, mat1, mat2, beta=0.5, alpha=0.5)
tensor(crow_indices=tensor([0, 1, 2, 3]),
    col_indices=tensor([0, 1, 2]),
    values=tensor([ 0.1423, -0.3903, -0.0950]), device='cuda:0',
    size=(3, 3), nnz=3, layout=torch.sparse_csr)