Skip to main content

Training molecular dynamics potentials.

Project description

Training Molecular Dynamics Potentials in JAX

Documentation Status

chemtrain is a library for training MD potentials and integrates with JAX, M.D. as its differentiable MD engine. Note that this is the first alpha release of chemtrain, expect breaking changes. Over the course of the next weeks, several updates will extend its functionalities and documentation.

Features

Incoming features:

Getting started

To get started with training MD potentials, using existing trainers that implement standard training schemes is the most straightforward apprach. Please refer to the provided examples as a refernece on how to set up the corresponding training environment and dataset.

trainer = trainers.Difftre(init_params,
                           optimizer)

trainer.add_statepoint(energy_fn_template, simulator_template,
                       neighbor_fn, timings, kbt, compute_fns, reference_state,
                       targets)
trainer.train(num_updates)

More advanced users may want to extend existing trainers or combine different trainers to implement custom training pipelines.

Installation

chemtrain can be installed via pip:

pip install jax-dimenet

Requirements

The repository uses the following packages:

    'jax',
    'jax-md',
    'jax-sgmc',
    'optax',
    'dm-haiku',
    'sympy',
    'tree_math',
    'cloudpickle',
    'chex',

The code runs with Python >=3.8.

Contribution

Contributions are always welcome! Please open a pull request to discuss the code additions.

Since this is a very early alpha release, do not hesitate to reach out if some feature or example is failing. If the specific feature is a priority for you, its support can be accelerated.

Contact

For questions, please contact stephan.thaler@tum.de or open an Issue on GitHub.

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

chemtrain-0.0.1.tar.gz (97.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chemtrain-0.0.1-py3-none-any.whl (114.2 kB view details)

Uploaded Python 3

File details

Details for the file chemtrain-0.0.1.tar.gz.

File metadata

  • Download URL: chemtrain-0.0.1.tar.gz
  • Upload date:
  • Size: 97.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for chemtrain-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e763907153aa3bd6965dc5ac7c66193e0ed3ed4fc90fbcd1354f8964f2fa8fb6
MD5 41eaa490b21db9e2bc880cf9068fc4fc
BLAKE2b-256 c81d67a27754a05f786d014826e069b90fa8e8efedaa383ca17b9ac2c73ba23e

See more details on using hashes here.

File details

Details for the file chemtrain-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: chemtrain-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 114.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for chemtrain-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a9beeedbd20466932e1cff9fb267282d44792fa680615294792df33223a5f70
MD5 747e877c1411d424518bfb6d0f95cfb1
BLAKE2b-256 25a2cab8d02a613fd71f37a80b11a62365d0e0ead4edca17c54a9caedb31977d

See more details on using hashes here.

Supported by

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