gammagl.layers.pool.global_sum_pool

class global_sum_pool(x, batch, size: int | None = None)

Returns batch-wise graph-level-outputs by adding node features across the node dimension, so that for a single graph \(\mathcal{G}_i\) its output is computed by

\[\mathbf{r}_i = \sum_{n=1}^{N_i} \mathbf{x}_n\]

Parameters:

• x (tensor) – Node feature matrix \(\mathbf{X} \in \mathbb{R}^{(N_1 + \ldots + N_B) \times F}\).

• batch (tensor) – Batch vector \(\mathbf{b} \in {\{ 0, \ldots, B-1\}}^N\), which assigns each node to a specific example.

• size (int, optional) – Batch-size \(B\). Automatically calculated if not given. (default: None)