-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More work on data and models documentation.
- Loading branch information
Showing
2 changed files
with
83 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,45 @@ | ||
|
||
============== | ||
Introduction | ||
============== | ||
Data is central in Machine Learning and ML4Chem provides some tools to | ||
prepare your datasets. We support the following: | ||
|
||
1. `Atomic Simulation Environment (ASE) <https://wiki.fysik.dtu.dk/ase/>`_. | ||
|
||
We will be adding support to other libraries, soon. | ||
|
||
|
||
=================== | ||
Data Handler | ||
=================== | ||
|
||
.. contents:: :local: | ||
|
||
Data is central in machine learning, and ML4Chem provides a | ||
:mod:`ml4chem.data.handler` module that allows users to adapt data to the | ||
right format to inter-operate with any of the provided models. | ||
The :mod:`ml4chem.data.handler` module allows users to adapt data to the | ||
right format to inter-operate with any other module of Ml4Chem. | ||
|
||
Its usage is very simple:: | ||
|
||
from ml4chem.data.handler import DataSet | ||
from ase.io import Trajectory | ||
|
||
images = Trajectory("images.traj") | ||
data_handler = DataSet(images, purpose="training") | ||
traing_set, targets = data_handler.get_images(purpose="training") | ||
|
||
In the example above, an ASE trajectory file is loaded into memory and passed | ||
as an argument to instantiate the ``DataSet`` class with | ||
``purpose="training"``. The ``.get_images()`` class method returns a hashed | ||
dictionary with the molecules in ``images.traj`` and the ``targets`` variable | ||
as a list of energies. | ||
|
||
For more information please refer to :mod:`ml4chem.data.handler`. | ||
|
||
=================== | ||
Visualization | ||
=================== | ||
|
||
We also offer a :mod:`ml4chem.data.visualization` module to plot some | ||
interesting graphics about your model, or even monitor the progress of the | ||
loss function minimization. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters