Skip to main content

Providing reproducible modeling

Project description

CARATE

Downloads License: GPL v3 Python Versions Style Black

Bert goes into the karate club

Why

Molecular representation is wrecked. Seriously! We chemists talked for decades with an ancient language about something we can't comprehend with that language. We have to stop it, now!

What

The success of transformer models is evident. Applied to molecules we need a graph-based transformer. Such models can then learn hidden representations of a molecule better suited to describe a molecule.

For a chemist it is quite intuitive but seldomly modelled as such: A molecule exhibits properties through its combined electronic and structural features

Scope

The aim is to implement the algorithm in a reusable way, e.g. for the chembee pattern. Actually, the chembee pattern is mimicked in this project to provide a stand alone tool. The overall structure of the program is reusable for other deep-learning projects and will be transferred to an own project that should work similar to opinionated frameworks.

Installation on CPU

Prepare system

sudo apt-get install python3-dev libffi-dev

Build manually

pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cpu 
pip install torch-scatter torch-sparse torch-geometric rdkit-pypi networkx[default] matplotlib
pip install torch-cluster 
pip install torch-spline-conv 

Faster way

Inside the directory of your git-clone:

pip install -e .

Usage

The program is meant to be run as a simple CLI. You can specify the configuration either via a JSON and use the program as a microservice, or you may run it locally from the command line. It is up to you.

Finally, with the new pyproject.toml it is possible to

pip install carate

The installation will install torch with CUDA, so the decision of the library what hardware to use goes JIT (just-in-time). At the moment only CPU/GPU is implemented and FPGA/TPU and others are ignored. Further development of the package will then focus on avoiding special library APIs but make the pattern adaptable to an arbitrary algorithmic/numerical backend.

carate -c path_to_config_file.py

Start a run

To start a run you need to define the configuration. You can do so by defining a .json or a config.py file

Examples for config.py files are given in config_files

Or you can check the the tutorial.ipynb in notebooks how to use the package with a .json file

Training results

Most of the training results are saved in a accumulative json on the disk. The reason is to have enough redundancy in case of data failure.

Previous experiments suggest to harden the machine for training to avoid unwanted side-effects as shutdowns, data loss, or data diffusion. You may still send intermediate results through the network, but store the large chunks on the hardened device.

Therefore, any ETL or data processing might not be affected by any interruption on the training machine.

Build on the project

Building on the code is not recommended as the project will be continued in another library (building with that would make most sense).

However, you may still use the models as they are by the means of the library production ready.

In case you can't wait for the picky scientist in me, you can still build on my intermediate results. You can find them in the following locations

Support the development

If you are happy about substantial progress in chemistry and life sciences that is not commercial first but citizen first, well then just

Buy Me A Coffee

Cite

There is a preprint available on bioRxiv. Read the preprint

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

carate-0.2.8.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

carate-0.2.8-py3-none-any.whl (40.7 kB view details)

Uploaded Python 3

File details

Details for the file carate-0.2.8.tar.gz.

File metadata

  • Download URL: carate-0.2.8.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for carate-0.2.8.tar.gz
Algorithm Hash digest
SHA256 cb727d1aea6da1039e0c508b0083b6abf6b843d76beb0bded39c42b3a5fa67de
MD5 df1f8dd6b8477b7f04bf3809d7c6954e
BLAKE2b-256 5208758f6dac93ab0fa86ad93e99dabb080b39f65f5536ca29cd15a3c98b1e35

See more details on using hashes here.

File details

Details for the file carate-0.2.8-py3-none-any.whl.

File metadata

  • Download URL: carate-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 40.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for carate-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7afb4641a0b340603e903f025849f220c978590a89cdf8fde0c8b8096958cb29
MD5 f336d2c68571e7b2e39377fd76247ae3
BLAKE2b-256 616ba8ac814b998fb310acfef1c2f63aa43935980f785c476e67bbcb4ea064bb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page