|
a |
|
b/examples/vae_example/README.md |
|
|
1 |
# SELFIES Example: Variational Autoencoder (VAE) for Chemistry |
|
|
2 |
|
|
|
3 |
An implementation of a variational autoencoder that runs on both SMILES and |
|
|
4 |
SELFIES. Included is code that compares the SMILES and SELFIES representations |
|
|
5 |
for a VAE using reconstruction quality, diversity, and latent space validity |
|
|
6 |
as metrics of interest. |
|
|
7 |
|
|
|
8 |
## Dependencies |
|
|
9 |
Dependencies are ``pytorch``, ``rdkit``, and ``pyyaml``, which can be installed |
|
|
10 |
using Conda. |
|
|
11 |
|
|
|
12 |
## Files |
|
|
13 |
|
|
|
14 |
* ``chemistry_vae.py``: the main file; contains the model definitions, |
|
|
15 |
the data processing, and the training. |
|
|
16 |
* ``settings.yml``: a file containing the hyperparameters of the |
|
|
17 |
model and the training. Also configures the VAE to run on either SMILES |
|
|
18 |
or SELFIES. |
|
|
19 |
* ``data_loader.py``: contains helper methods that convert SMILES and SELFIES |
|
|
20 |
into integer-encoded or one-hot encoded vectors. |
|
|
21 |
|
|
|
22 |
### Tested at: |
|
|
23 |
- Python 3.7 |
|
|
24 |
|
|
|
25 |
CPU and GPU supported |
|
|
26 |
|
|
|
27 |
For comments, bug reports or feature ideas, please send an email to |
|
|
28 |
mario.krenn@utoronto.ca and alan@aspuru.com |
|
|
29 |
|