Skip to content

Commit a82a320

Browse files
small doc update
1 parent 1167e76 commit a82a320

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/src/messagepassing.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,17 @@ and to ``\gamma_x`` and ``\gamma_e`` as to the node update and edge update funct
1616
respectively. The aggregation ``\square`` is over the neighborhood ``N(i)`` of node ``i``,
1717
and it is usually equal either to ``\sum``, to `max` or to a `mean` operation.
1818

19-
In GraphNeuralNetworks.jl, the function [`propagate`](@ref) takes care of materializing the
20-
node features on each edge, applying the message function, performing the
19+
In GraphNeuralNetworks.jl, the message passing mechanism is exposed by the [`propagate`](@ref) function.
20+
[`propagate`](@ref) takes care of materializing the node features on each edge, applying the message function, performing the
2121
aggregation, and returning ``\bar{\mathbf{m}}``.
2222
It is then left to the user to perform further node and edge updates,
2323
manipulating arrays of size ``D_{node} \times num\_nodes`` and
2424
``D_{edge} \times num\_edges``.
2525

26-
[`propagate`](@ref) is composed of two steps corresponding to two
27-
exported methods:
28-
1. [`apply_edges`](@ref) materializes node features on edges and
29-
performs edge-related computation without.
30-
2. [`aggregate_neighbors`](@ref) applies a reduction operator on the messages coming
31-
from the neighborhood of each node.
26+
[`propagate`](@ref) is composed of two steps, also available as two independent methods:
27+
28+
1. [`apply_edges`](@ref) materializes node features on edges and applyes the message function.
29+
2. [`aggregate_neighbors`](@ref) applies a reduction operator on the messages coming from the neighborhood of each node.
3230

3331
The whole propagation mechanism internally relies on the [`NNlib.gather`](@ref)
3432
and [`NNlib.scatter`](@ref) methods.

0 commit comments

Comments
 (0)