Deep Reinforcement Library for Conformer Generation
Project description
conformer-rl
An open-source deep reinforcement learning library for conformer generation.
Documentation
Documentation can be found at https://conformer-rl.readthedocs.io/.
Installation
-
Prerequisites
-
Install RDKit
$ conda install -c conda-forge rdkit
-
Install PyTorch Geometric. Since the installation is heavily dependent on the PyTorch, OS and CUDA versionsof the system, detailed instructions for installing PyTorch Geometric can be found at https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html.
-
-
Install conformer-rl
$ pip install conformer-rl
-
Verify Installation As a quick check to verify the installation has succeeded, navigate to the
examples
directory and runtest_example.py
. The script should finish running in a few minutes or less. If no errors ware encountered then most likely the installation has succeeded.
Features
-
Agents -
conformer_rl
contains implementations of agents for several deep reinforcement learning algorithms, including recurrent and non-recurrent versions of A2C and PPO.conformer_rl
also includes a base agent interface BaseAgent for constructing new agents. -
Models - Implementations of various graph neural network models are included. Each model is compatible with any molecule.
-
Environments - Implementations for several pre-built environments that are compatible with any molecule. Environments are built on top of the modularized ConformerEnv interface, making it easy to create custom environments and max-and-match different environment components.
-
Analysis -
conformer_rl
contains a module for visualizing metrics and molecule conformers in Jupyter/IPython notebooks.examples/example_analysis.ipynb
shows some examples on how the visualizing tools can be used.
Quick Start
The examples
directory contain several scripts for training on pre-built agents and environments.
Visit Quick Start to get started.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for conformer_rl-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9c1d96a8840d8fa27bbf3e8ed358d0ba81cb5491f7a8dc992354fb7f38fc3d2 |
|
MD5 | 0ee01dd58b9c0ca5c9b0f8730536e05f |
|
BLAKE2b-256 | 6c17de78a88a69e764f6ede5d0218eff2f40666d5166b34af69f58fe55e273d1 |