Skip to content

Commit 8742cf6

Browse files
committed
Merge branch 'CGConv' of github.com:emsal1863/GeometricFlux.jl into CGConv
2 parents 434e1ae + ca33a1c commit 8742cf6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/layers/conv.jl

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -454,8 +454,12 @@ Crystal Graph Convolutional network. Uses both node and edge features.
454454
455455
# Usage
456456
457-
You can call `CGConv` in several different ways, including
458-
- With FeaturedGraph
457+
You can call `CGConv` in several different ways:
458+
459+
- Pass a FeaturedGraph: `CGConv(fg)`, returns `FeaturedGraph`
460+
- Pass both node and edge features: `CGConv(X, E)`
461+
- Pass one matrix, which can either be node features or edge features: `CGConv(M; edge)`:
462+
`edge` is default false, meaning that `M` denotes node features.
459463
"""
460464
struct CGConv{V <: AbstractFeaturedGraph, T,
461465
A <: AbstractMatrix{T}, B} <: MessagePassing

0 commit comments

Comments
 (0)