Skip to content

Commit e46d1b0

Browse files
CarloLucibelloCarloLucibello
committed
update all README.md
1 parent 1a72242 commit e46d1b0

File tree

5 files changed

+119
-54
lines changed

5 files changed

+119
-54
lines changed

‎GNNGraphs/README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,36 @@
11
# GNNGraphs.jl
22

3+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GraphNeuralNetworks.jl/)
4+
35
A package implementing graph types for graph deep learning.
46

5-
This package is currently under development and may break frequentely.
6-
It is not meant for final users but for GNN libraries developers.
7-
Final user should use GraphNeuralNetworks.jl instead.
7+
The package is part of the [GraphNeuralNetworks.jl ecosystem](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl) and is re-exported by the frontend packages [GraphNeuralNetworks.jl](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GraphNeuralNetworks.jl/) and [GNNLux.jl](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GNNLux.jl/).
8+
9+
## Installation
10+
11+
Install through the Julia package manager.
12+
13+
```julia
14+
pkg> add GNNGraphs
15+
```
16+
17+
## Usage
18+
19+
For a comprehensive introduction to the library, refer to the [Documentation](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GNNGraphs.jl/).
20+
21+
22+
## Citing
23+
24+
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate a reference
25+
to [our paper](https://arxiv.org/abs/2412.06354):
26+
27+
```
28+
@article{lucibello2024graphneuralnetworks,
29+
title={GraphNeuralNetworks.jl: Deep Learning on Graphs with Julia},
30+
author={Lucibello, Carlo and Rossi, Aurora},
31+
journal={arXiv preprint arXiv:2412.06354},
32+
url={https://arxiv.org/abs/2412.06354},
33+
year={2024}
34+
}
35+
```
36+

‎GNNLux/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
1+
<img align="right" width="300px" src="https://raw.githubusercontent.com/JuliaGraphs/GraphNeuralNetworks.jl/master/docs/logo.svg">
2+
13
# GNNLux.jl
24

5+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GNNLux.jl/)
6+
7+
Graph convolutional layers based on the deep learning framework [Lux.jl](https://lux.csail.mit.edu/stable/).
8+
This is the frontend package for Lux users of the [GraphNeuralNetworks.jl ecosystem](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl).
9+
10+
11+
### Features
12+
13+
**GNNLux.jl** supports the following features:
14+
15+
- Implementation of common graph convolutional layers.
16+
- Computation on batched graphs.
17+
- Custom layer definitions.
18+
- Support for CUDA and AMDGPU.
19+
- Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
20+
- [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/examples) of node, edge, and graph-level machine learning tasks.
21+
- Heterogeneous and dynamical graphs and convolutions.
22+
23+
## Installation
24+
25+
Install through the Julia package manager.
26+
27+
```julia
28+
pkg> add GNNLux
29+
```
30+
31+
## Usage
32+
33+
For a comprehensive introduction to the library, refer to the [Documentation](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GNNLux.jl/).
34+
35+
## Citing
36+
37+
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate a reference
38+
to [our paper](https://arxiv.org/abs/2412.06354):
39+
40+
```
41+
@article{lucibello2024graphneuralnetworks,
42+
title={GraphNeuralNetworks.jl: Deep Learning on Graphs with Julia},
43+
author={Lucibello, Carlo and Rossi, Aurora},
44+
journal={arXiv preprint arXiv:2412.06354},
45+
url={https://arxiv.org/abs/2412.06354},
46+
year={2024}
47+
}
48+
```

‎GNNlib/README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# GNNlib.jl
22

3-
This package contains a collection deep-learning framework agnostic
4-
building blocks for graph neural networks such as message passing operators and implementations of graph convolutional layers.
3+
This package contains a collection framework-agnostic
4+
building blocks for deep learning on graphs such as message passing operators and implementations of graph convolutional layers.
55

6-
In the future it will serve as the foundation of GraphNeuralNetworks.jl (based on Flux,jl).
7-
GNNlib.jl will be to GraphNeuralNetworks.jl what NNlib.jl is to Flux.jl and Lux.jl.
8-
9-
This package is currently under development and may break frequentely.
10-
It is not meant for final users but for GNN libraries developers.
11-
Final user should use GraphNeuralNetworks.jl instead.
6+
See [GraphNeuralNetworks.jl](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GraphNeuralNetworks.jl/) for a Flux-based frontend package that uses this library and [GNNLux.jl](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GNNLux.jl/) for a Lux-based one.
127

138

‎GraphNeuralNetworks/README.md

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,48 @@
1-
<img align="right" width="300px" src="https://raw.githubusercontent.com/JuliaGraphs/GraphNeuralNetworks.jl/master/docs/src/assets/logo.svg">
2-
1+
<img align="right" width="300px" src="https://raw.githubusercontent.com/JuliaGraphs/GraphNeuralNetworks.jl/master/docs/logo.svg">
32

43
# GraphNeuralNetworks.jl
54

6-
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaGraphs.github.io/GraphNeuralNetworks.jl/stable)
7-
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaGraphs.github.io/GraphNeuralNetworks.jl/dev)
8-
![](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/actions/workflows/ci.yml/badge.svg)
9-
[![codecov](https://codecov.io/gh/JuliaGraphs/GraphNeuralNetworks.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaGraphs/GraphNeuralNetworks.jl)
5+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GraphNeuralNetworks.jl/)
6+
7+
Graph convolutional layers based on the deep learning framework [Flux.jl](https://fluxml.ai/).
8+
This is the frontend package for Flux users of the [GraphNeuralNetworks.jl ecosystem](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl).
109

1110

12-
GraphNeuralNetworks.jl is a graph neural network library written in Julia and based on the deep learning framework [Flux.jl](https://github.com/FluxML/Flux.jl).
11+
### Features
1312

14-
Among its features:
13+
**GraphNeuralNetworks.jl** supports the following features:
1514

16-
* Implements common graph convolutional layers.
17-
* Supports computations on batched graphs.
18-
* Easy to define custom layers.
19-
* CUDA support.
20-
* Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
21-
* [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) of node, edge, and graph level machine learning tasks.
22-
* Heterogeneous and temporal graphs.
15+
- Implementation of common graph convolutional layers.
16+
- Computation on batched graphs.
17+
- Custom layer definitions.
18+
- Support for CUDA and AMDGPU.
19+
- Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
20+
- [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/examples) of node, edge, and graph-level machine learning tasks.
21+
- Heterogeneous and dynamical graphs and convolutions.
2322

24-
## Installation
23+
## Installation
2524

26-
GraphNeuralNetworks.jl is a registered Julia package. You can easily install it through the package manager:
25+
Install the package through the Julia package manager.
2726

2827
```julia
2928
pkg> add GraphNeuralNetworks
3029
```
3130

3231
## Usage
3332

34-
Usage examples can be found in the [examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) and in the [notebooks](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/notebooks) folder. Also, make sure to read the [documentation](https://JuliaGraphs.github.io/GraphNeuralNetworks.jl/dev) for a comprehensive introduction to the library.
35-
33+
For a comprehensive introduction to the library, refer to the [Documentation](https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GraphNeuralNetworks.jl/).
3634

3735
## Citing
3836

39-
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate the following reference:
37+
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate a reference
38+
to [our paper](https://arxiv.org/abs/2412.06354):
4039

4140
```
42-
@misc{Lucibello2021GNN,
43-
author = {Carlo Lucibello and other contributors},
44-
title = {GraphNeuralNetworks.jl: a geometric deep learning library for the Julia programming language},
45-
year = 2021,
46-
url = {https://github.com/JuliaGraphs/GraphNeuralNetworks.jl}
41+
@article{lucibello2024graphneuralnetworks,
42+
title={GraphNeuralNetworks.jl: Deep Learning on Graphs with Julia},
43+
author={Lucibello, Carlo and Rossi, Aurora},
44+
journal={arXiv preprint arXiv:2412.06354},
45+
url={https://arxiv.org/abs/2412.06354},
46+
year={2024}
4747
}
48-
```
49-
50-
## Acknowledgments
51-
52-
GraphNeuralNetworks.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/), [Deep Graph Library](https://docs.dgl.ai/),
53-
and [GeometricFlux.jl](https://fluxml.ai/GeometricFlux.jl/stable/).
54-
55-
48+
```

‎README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
[![codecov](https://codecov.io/gh/JuliaGraphs/GraphNeuralNetworks.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaGraphs/GraphNeuralNetworks.jl)
1010

1111

12-
**Libraries for deep learning on graphs in Julia**, using either [Flux.jl](https://fluxml.ai/Flux.jl/stable/) or [Lux.jl](https://lux.csail.mit.edu/stable/) as backend frameworks.
12+
**Libraries for deep learning on graphs in Julia**, using either [Flux.jl](https://fluxml.ai/) or [Lux.jl](https://lux.csail.mit.edu/stable/) as backend frameworks.
1313

1414
This repository contains the following packages:
1515

16-
- **GraphNeuralNetworks.jl**: Provides graph convolutional layers based on the deep learning framework [Flux.jl](https://fluxml.ai/Flux.jl/stable/). This is the frontend package for Flux users.
16+
- **GraphNeuralNetworks.jl**: Provides graph convolutional layers based on the deep learning framework [Flux.jl](https://fluxml.ai/). This is the frontend package for Flux users.
1717

18-
- **GNNLux.jl**: Offers graph convolutional layers based on the deep learning framework [Lux.jl](https://lux.csail.mit.edu/stable/). This is the frontend package for Lux users.
18+
- **GNNLux.jl**: Offers graph convolutional layers based on the deep learning framework [Lux.jl](https://lux.csail.mit.edu/). This is the frontend package for Lux users.
1919

2020
- **GNNGraphs.jl**: Provides graph data structures and helper functions for working with graph data. This package is re-exported by the frontend packages.
2121

@@ -31,7 +31,7 @@ Both **GraphNeuralNetworks.jl** and **GNNLux.jl** support the following features
3131
- Support for CUDA and AMDGPU.
3232
- Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
3333
- [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/examples) of node, edge, and graph-level machine learning tasks.
34-
- Support for heterogeneous and temporal graphs.
34+
- Heterogeneous and dynamical graphs and convolutions.
3535

3636
## Installation
3737

@@ -57,14 +57,16 @@ For a comprehensive introduction to the library, refer to the [Documentation](ht
5757

5858
## Citing
5959

60-
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate the following reference:
60+
If you use GraphNeuralNetworks.jl in a scientific publication, we would appreciate a reference
61+
to [our paper](https://arxiv.org/abs/2412.06354):
6162

6263
```
63-
@misc{Lucibello2021GNN,
64-
author = {Carlo Lucibello and other contributors},
65-
title = {GraphNeuralNetworks.jl: a geometric deep learning library for the Julia programming language},
66-
year = 2021,
67-
url = {https://github.com/JuliaGraphs/GraphNeuralNetworks.jl}
64+
@article{lucibello2024graphneuralnetworks,
65+
title={GraphNeuralNetworks.jl: Deep Learning on Graphs with Julia},
66+
author={Lucibello, Carlo and Rossi, Aurora},
67+
journal={arXiv preprint arXiv:2412.06354},
68+
url={https://arxiv.org/abs/2412.06354},
69+
year={2024}
6870
}
6971
```
7072

0 commit comments

Comments
 (0)