Skip to content

Commit

Permalink
updated readme to reflect CI
Browse files Browse the repository at this point in the history
  • Loading branch information
maniospas committed Aug 1, 2024
1 parent 09c4d7f commit 78d2d73
Showing 1 changed file with 28 additions and 25 deletions.
53 changes: 28 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
# JGNN
# JGNN

A native Java library for Graph Neural Networks.
A native Java library for graph neural networks.

# :dart: About
## :dart: About

Graph Neural Networks (GNNs) are getting more and more popular;
Graph Neural Networks (GNN) are getting more and more popular;
they can reason from relational information and perform inference from small datasets.
JGNN implements GNNs for native Java applications to supports cross-platform machine
learning, such as on Android, without dedicated hardware or firmware.

* [Tutorials](tutorials/README.md)
* [Javadoc](https://mklab-iti.github.io/JGNN/)

# :rocket: Setup and features

Find the latest nightly release as as JAR from [here](https://github.com/MKLab-ITI/JGNN/releases/latest/download/JGNN.jar).
Download this and add it in your project's dependencies.
To install the latest stable version, include it as a Maven or Gradle dependency
by following the instructions of its JitPack distribution:
[![](https://jitpack.io/v/MKLab-ITI/JGNN.svg)](https://jitpack.io/#MKLab-ITI/JGNN)
JGNN provides implementations that do not require dedicated hardware or firmware.

* Cross-platform (written in native java)
* Lightweight
* Minimal memory footprint
* Parallelized batching
* [Neuralang](tutorials/Neuralang.md) scripting language for model definition

## :rocket: Setup and links

# :thumbsup: Contributing
Get the JAR file for a specific version from the project's releases
[releases](https://github.com/MKLab-ITI/JGNN/releases). Add this to your dependencies.
Alternatively, include the latest nightly version as a Maven or Gradle dependency
by following the instructions of the JitPack distribution:

Feel free to contribute in any way, for example through the [issue tracker](https://github.com/MKLab-ITI/JGNN/issues). In addition to bug reports, requests for features and clarifications are welcome. Please check out the [contribution guidelines](CONTRIBUTING.md) when bringing modifications to the code base.

[![](https://jitpack.io/v/MKLab-ITI/JGNN.svg)](https://jitpack.io/#MKLab-ITI/JGNN)


# :notebook: Citation
:cyclone: [Tutorials](tutorials/README.md)<br>
:cyclone: [Javadoc](https://mklab-iti.github.io/JGNN/)


## :thumbsup: Contributing

Feel free to contribute in any way, for example through the [issue tracker](https://github.com/MKLab-ITI/JGNN/issues). In addition to bug reports, requests for features and clarifications are welcome.


## :notebook: Citation

```
@article{krasanakis2023101459,
Expand All @@ -49,12 +49,15 @@ Feel free to contribute in any way, for example through the [issue tracker](http
}
```

# :cyclone: Changes since 1.0.0
<details>
<summary> <b>Changes since the publication's v1.0.0</b> </summary>

* [Neuralang](tutorials/Neuralang.md)
* Introduced [Neuralang](tutorials/Neuralang.md)
* Autosized parameteters
* Up to 30% less memory
* Up to 90% less running time
* Up to 80% less running time
* Renamed `GCNBuilder` to `FastBuilder`
* Neighbor attention and message passing
* Sort pooling and graph classification
* Sort pooling and graph classification

</details>

0 comments on commit 78d2d73

Please sign in to comment.