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 (Tensor) – 要添加並用於計算採樣矩陣乘法的形狀為 (m, n) 的稀疏 CSR 矩陣

• mat1 (Tensor) – 要相乘的形狀為 (m, k) 的密集矩陣

• mat2 (Tensor) – 要相乘的形狀為 (k, n) 的密集矩陣

關鍵字參數

• beta (Number, optional) – input 的乘數 ($\beta$)

• alpha (Number, optional) – $mat1 @ mat2$ 的乘數 ($\alpha$)

• out (Tensor, optional) – 輸出張量。 如果 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)