Skip to content

Commit c44f088

Browse files
Merge pull request #78 from pitmonticone/master
Fixed typos in the docs
2 parents b230ab1 + fc119f2 commit c44f088

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Among its features:
1818

1919
## Installation
2020

21-
GNN.jl is a registered julia package. You can easily install it through the package manager:
21+
GraphNeuralNetworks.jl is a registered Julia package. You can easily install it through the package manager:
2222

2323
```julia
2424
pkg> add GraphNeuralNetworks
@@ -30,7 +30,7 @@ Usage examples can be found in the [examples](https://github.com/CarloLucibello/
3030

3131
## Acknowledgments
3232

33-
GNN.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/), [Deep Graph Library](https://docs.dgl.ai/),
33+
GraphNeuralNetworks.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/), [Deep Graph Library](https://docs.dgl.ai/),
3434
and [GeometricFlux.jl](https://fluxml.ai/GeometricFlux.jl/stable/).
3535

3636

docs/src/datasets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Datasets
22

3-
GNN.jl doesn't come with its own datasets, but leverages those available in the julia (and non-julia) ecosytem. In particular, the [examples in the GNN.jl repository](https://github.com/CarloLucibello/GraphNeuralNetworks.jl/tree/master/examples) make use of the [MLDatasets.jl](https://github.com/JuliaML/MLDatasets.jl) package. There you will find common graph datasets sich as Cora, PubMed, and Citeseer.
4-
Also MLDatasets gives access to the [TUDataset](https://chrsmrrs.github.io/datasets/docs/datasets/) repository and its numerous datasets.
3+
GraphNeuralNetworks.jl doesn't come with its own datasets, but leverages those available in the Julia (and non-Julia) ecosystem. In particular, the [examples in the GraphNeuralNetworks.jl repository](https://github.com/CarloLucibello/GraphNeuralNetworks.jl/tree/master/examples) make use of the [MLDatasets.jl](https://github.com/JuliaML/MLDatasets.jl) package. There you will find common graph datasets such as Cora, PubMed, and Citeseer.
4+
Also MLDatasets gives access to the [TUDataset](https://chrsmrrs.github.io/datasets/docs/datasets/) repository and its numerous datasets.

docs/src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GraphNeuralNetworks
22

33
This is the documentation page for [GraphNeuralNetworks.jl](https://github.com/CarloLucibello/GraphNeuralNetworks.jl), a graph neural network library written in Julia and based on the deep learning framework [Flux.jl](https://github.com/FluxML/Flux.jl).
4-
GNN.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/),[Deep Graph Library](https://docs.dgl.ai/),
4+
GraphNeuralNetworks.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/),[Deep Graph Library](https://docs.dgl.ai/),
55
and [GeometricFlux.jl](https://fluxml.ai/GeometricFlux.jl/stable/).
66

77
Among its features:
@@ -52,7 +52,7 @@ GNNGraph:
5252

5353
### Model building
5454

55-
We concisely define our model as a [`GNNChain`](@ref) containing 2 graph convolutaional
55+
We concisely define our model as a [`GNNChain`](@ref) containing 2 graph convolutional
5656
layers. If CUDA is available, our model will live on the gpu.
5757

5858
```julia
@@ -72,7 +72,7 @@ julia> opt = ADAM(1f-4);
7272

7373
### Training
7474

75-
Finally, we use a standard Flux training pipeling to fit our dataset.
75+
Finally, we use a standard Flux training pipeline to fit our dataset.
7676
Flux's DataLoader iterates over mini-batches of graphs
7777
(batched together into a `GNNGraph` object).
7878

docs/src/messagepassing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ 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 GNN.jl, the function [`propagate`](@ref) takes care of materializing the
19+
In GraphNeuralNetworks.jl, the function [`propagate`](@ref) takes care of materializing the
2020
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,
@@ -144,4 +144,4 @@ See the [`GATConv`](@ref) implementation [here](https://github.com/CarloLucibell
144144
## Built-in message functions
145145

146146
In order to exploit optimized specializations of the [`propagate`](@ref), it is recommended
147-
to use built-in message functions such as [`copy_xj`](@ref) whenever possible.
147+
to use built-in message functions such as [`copy_xj`](@ref) whenever possible.

docs/src/models.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ model = GNNChain(GCNConv(din => d),
8787

8888
The `GNNChain` only propagates the graph and the node features. More complex scenarios, e.g. when also edge features are updated, have to be handled using the explicit definition of the forward pass.
8989

90-
A `GNNChain` oppurtunely propagates the graph into the branches created by the `Flux.Parallel` layer:
90+
A `GNNChain` opportunely propagates the graph into the branches created by the `Flux.Parallel` layer:
9191

9292
```julia
9393
AddResidual(l) = Parallel(+, identity, l) # implementing a skip/residual connection
@@ -105,7 +105,7 @@ y = model(g, X) # output size: (dout, g.num_graphs)
105105
## Embedding a graph in the model
106106

107107
Sometimes it is useful to consider a specific graph as a part of a model instead of
108-
its input. GNN.jl provides the [`WithGraph`](@ref) type to deal with this scenario.
108+
its input. GraphNeuralNetworks.jl provides the [`WithGraph`](@ref) type to deal with this scenario.
109109

110110
```julia
111111
chain = GNNChain(GCNConv(din => d, relu),

0 commit comments

Comments
 (0)