Add alternative edge indices shape to GCNConv input description (#8269

) <img width="752" alt="Screenshot 2023-10-26 at 1 05 22 PM" src="https://github.com/pyg-team/pytorch_geometric/assets/54658925/fa7d55b6-30ac-4036-baf3-1133e5c47257"> According to the implementation https://github.com/pyg-team/pytorch_geometric/blob/master/torch_geometric/nn/conv/gcn_conv.py#L49, sparse adjacency matrix of shape |V|*|V| can also be used as edge_indices. --------- Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Matthias Fey <[email protected]>
pyg-team · Oct 28, 2023 · b02fa20 · b02fa20
1 parent 67a8b78
commit b02fa20
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/torch_geometric/nn/conv/gcn_conv.py b/torch_geometric/nn/conv/gcn_conv.py
@@ -159,7 +159,8 @@ class GCNConv(MessagePassing):
     Shapes:
         - **input:**
           node features :math:`(|\mathcal{V}|, F_{in})`,
-          edge indices :math:`(2, |\mathcal{E}|)`,
+          edge indices :math:`(2, |\mathcal{E}|)`
+          or sparse matrix :math:`(|\mathcal{V}|, |\mathcal{V}|)`,
           edge weights :math:`(|\mathcal{E}|)` *(optional)*
         - **output:** node features :math:`(|\mathcal{V}|, F_{out})`
     """