Skip to content

Commit

Permalink
Small improvement to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
muammar committed Nov 21, 2019
1 parent 2434c88 commit 2196266
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,19 @@



This package is written in Python 3, and intends to offer modern and rich
features to perform machine learning workflows for chemical physics.
ML4Chem is a package to deploy machine learning for chemistry and materials
science. It is written in Python 3, and intends to offer modern and rich
features to perform machine learning (ML) workflows for chemical physics.

A list of features and methods are shown below.
A list of features and ML algorithms are shown below.

- PyTorch backend.
- Completely modular. You can use any part of this package in your project.
- Free software <3. No secrets! Pull requests and additions are more than
welcome!
- Documentation (work in progress).
- Explicit and idiomatic: `ml4chem.get_me_a_coffee()`.
- Distributed training in a data parallelism paradigm (mini-batches).
- Distributed training in a data parallel paradigm aka mini-batches.
- Scalability and distributed computations are powered by Dask.
- Real-time tools to track status of your computations.
- [Messagepack serialization](https://msgpack.org/index.html).
Expand All @@ -38,10 +39,10 @@ If you find this software useful, please use this DOI to cite it:

## Documentation

You can read the documentation at [https://ml4chem.dev](https://ml4chem.dev)
where you can get started. It is arranged in a way that you can go through
the theory as well as some code snippets to understand how to use this
software. Additionally, you can dive through the [module
To get started, read the documentation at
[https://ml4chem.dev](https://ml4chem.dev). It is arranged in a way that you
can go through the theory as well as some code snippets to understand how to
use this software. Additionally, you can dive through the [module
index](https://ml4chem.dev/genindex.html) to get more information about
different classes and functions of ML4Chem.

Expand Down

0 comments on commit 2196266

Please sign in to comment.