Skip to content

Commit b1d7936

Browse files
authored
New introduction to monorepo (#512)
* New monorepo docs * Better version
1 parent 39d1fb2 commit b1d7936

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

GraphNeuralNetworks/docs/src/index.md

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

3-
This is the documentation page for [GraphNeuralNetworks.jl](https://github.com/JuliaGraphs/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-
GraphNeuralNetworks.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/), [Deep Graph Library](https://docs.dgl.ai/),
5-
and [GeometricFlux.jl](https://fluxml.ai/GeometricFlux.jl/stable/).
3+
This is the monorepository for the GraphNeuralNetworks project, bringing together all code into a unified structure to facilitate code sharing and reusability across different project components. It contains the following packages:
64

75
- `GraphNeuralNetwork.jl`: Package that contains stateful graph convolutional layers based on the machine learning framework [Flux.jl](https://fluxml.ai/Flux.jl/stable/). This is fronted package for Flux users. It depends on GNNlib.jl, GNNGraphs.jl, and Flux.jl packages.
86

9-
* Implements common graph convolutional layers.
10-
* Supports computations on batched graphs.
11-
* Easy to define custom layers.
12-
* CUDA support.
13-
* Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
14-
* [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) of node, edge, and graph level machine learning tasks.
7+
- `GNNLux.jl`: Package that contains stateless graph convolutional layers based on the machine learning framework [Lux.jl](https://lux.csail.mit.edu/stable/). This is fronted package for Lux users. It depends on GNNlib.jl, GNNGraphs.jl, and Lux.jl packages.
8+
9+
- `GNNlib.jl`: Package that contains the core graph neural network layers and utilities. It depends on GNNGraphs.jl and GNNlib.jl packages and serves for code base for GraphNeuralNetwork.jl and GNNLux.jl packages.
10+
11+
- `GNNGraphs.jl`: Package that contains the graph data structures and helper functions for working with graph data. It depends on Graphs.jl package.
12+
13+
Here is a schema of the dependencies between the packages:
14+
15+
![Monorepo schema](assets/schema.png)
1516

1617

1718

1819

19-
Usage examples on real datasets can be found in the [examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) folder.
2020

0 commit comments

Comments
 (0)