Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning to training setup #469

Merged
merged 1 commit into from
Jun 1, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions examples/nnp_training.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@
.. note::
TorchANI provide tools to run NeuroChem training config file `inputtrain.ipt`.
See: :ref:`neurochem-training`.

.. warning::
The training setup used in this file is configured to reproduce the original research
at `Less is more: Sampling chemical space with active learning`_ as much as possible.
That research was done on a different platform called NeuroChem which has many default
options and technical details different from PyTorch. Some decisions made here
(such as, using NeuroChem's initialization instead of PyTorch's default initialization)
is not because it gives better result, but solely based on reproducing the original
research. This file should not be interpreted as a suggestions to the readers on how
they should setup their models.

.. _`Less is more: Sampling chemical space with active learning`:
https://aip.scitation.org/doi/full/10.1063/1.5023802
"""

###############################################################################
Expand Down