Navigation Menu

Skip to content

Chemellia/AtomicGraphNets.jl

Repository files navigation

AtomicGraphNets.jl

Run tests codecov Dev

AtomicGraphNets.jl implements graph-based models for machine learning on atomic systems, such as Crystal Graph Convolutional Neural Nets, in Julia. It makes use of the Flux ecosystem for model building and the JuliaGraphs ecosystem for graph representation and visualization, as well as adapting some features from GeometricFlux.

Documentation is in progress over here.

Getting Started

  1. To install the latest tagged version, in your Julia REPL, do ]add AtomicGraphNets. However, you can also play with the latest version on the main branch by skipping to step 2 and then doing ]add /path/to/repo where you replace the dummy path with the location of your clone.

  2. Clone this package to wherever you want to play.

  3. Go and try out the example in examples/example1/ – it has its own README file with detailed instructions.

Contributing

We welcome community contributions! Please refer to contribution guide for suggestions on how to go about things.

Acknowledgements

Many thanks to Dhairya Gandhi for helping out with some adjoints to actually make these layers trainable! :D