Skip to content

Commit 70217ec

Browse files
committed
Better monorepo index
1 parent e0a36ff commit 70217ec

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

GraphNeuralNetworks/docs/src/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,49 @@ Here is a schema of the dependencies between the packages:
1515
![Monorepo schema](assets/schema.png)
1616

1717

18+
Among its general features:
19+
20+
* Implements common graph convolutional layers both in stateful and stateless form.
21+
* Supports computations on batched graphs.
22+
* Easy to define custom layers.
23+
* CUDA support.
24+
* Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
25+
* [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) of node, edge, and graph level machine learning tasks.
26+
* Heterogeneous and temporal graphs.
27+
28+
## Installation
29+
30+
GraphNeuralNetworks.jl, GNNlib.jl and GNNGraphs.jl are a registered Julia packages. You can easily install a package, for example GraphNeuralNetworks.jl, through the package manager :
31+
32+
```julia
33+
pkg> add GraphNeuralNetworks
34+
```
35+
36+
## Usage
37+
38+
Usage examples can be found in the [examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/examples) and in the [notebooks](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/notebooks) folder. Also, make sure to read the [documentation](https://juliagraphs.org/GraphNeuralNetworks.jl/graphneuralnetworks/) for a comprehensive introduction to the library and the [tutorials](https://juliagraphs.org/GraphNeuralNetworks.jl/tutorials/).
39+
40+
41+
## Citing
42+
43+
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate the following reference:
44+
45+
```
46+
@misc{Lucibello2021GNN,
47+
author = {Carlo Lucibello and other contributors},
48+
title = {GraphNeuralNetworks.jl: a geometric deep learning library for the Julia programming language},
49+
year = 2021,
50+
url = {https://github.com/JuliaGraphs/GraphNeuralNetworks.jl}
51+
}
52+
```
53+
54+
## Acknowledgments
55+
56+
GraphNeuralNetworks.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/), [Deep Graph Library](https://docs.dgl.ai/),
57+
and [GeometricFlux.jl](https://fluxml.ai/GeometricFlux.jl/stable/).
58+
59+
60+
1861

1962

2063

0 commit comments

Comments
 (0)