Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
khaledkah authored Apr 4, 2024
1 parent 7ded3ba commit 5f86b4e
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# MoreRed: Molecular Relaxation by Reverse Diffusion
MoreRed is built on top of [SchNetPack 2.0](https://github.com/atomistic-machine-learning/schnetpack/tree/master), an easily configurable and extendible library for constructing and training neural network models for atomistic systems like molecules. SchNetPack utilizes [PyTorch Lightning](https://www.pytorchlightning.ai/) for model building and [Hydra](https://hydra.cc/) for straightforward management of experimental configurations. While high level usage of the `morered` package to train and use the models described in the original paper does not require knowledge of its underlying dependencies, we recommend users familiarize themselves with Hydra to be able to customize their experimental configurations. Additionally, the tutorials and the documentation provided in [SchNetPack 2.0](https://github.com/atomistic-machine-learning/schnetpack/tree/master) can be helpful. Below, we explain how to use the `morered` package.

# Content
+ [Installation](/README.md#installation)
+ [Usage](/README.md#Usage)
+ [Training](/README.md##Training)
+ [Molecular relaxation](/README.md##Molecular-relaxation)
+ [Molecular structure generation](/README.md##Molecular-structure-generation)
+ [How to cite](/README.md##How-to-cite)
## Content
+ [Installation](/README.md##installation)
+ [Usage](/README.md##Usage)
+ [Training](/README.md###Training)
+ [Molecular relaxation](/README.md###Molecular-relaxation)
+ [Molecular structure generation](/README.md###Molecular-structure-generation)
+ [How to cite](/README.md###How-to-cite)

# Installation
## Installation
Requirements:
- python >= 3.8
- SchNetPack 2.0
Expand All @@ -30,18 +30,18 @@ Now to install the package, inside the folder `MoreRed` run:
```
pip install .
```
# Usage
## Usage
The human-readable and customizable YAML configuration files under `/src/morered/configs` are all you need to train and run customizable experiments with `morered`. They follow the configuration structure used in [SchNetPack 2.0](https://github.com/atomistic-machine-learning/schnetpack/tree/master). Here, we explain how to train and use the different models. Besides, under the folder `notebooks` we provide step-by-step Jupyter notebooks explaining the building blocks of MoreRed and how to use the different trained models.

## Training
### Training

### MoreRed-JT
#### MoreRed-JT
You can train the `MoreRed-JT` model with the default configuration by simply running:
```
pip install .
```
## Molecular relaxation
### Molecular relaxation

## Molecular structure generation
### Molecular structure generation

# How to cite
## How to cite

0 comments on commit 5f86b4e

Please sign in to comment.