Standard model outputs

In order for multiple simulation engines to be able use arbitrary metatomic models to compute atomic properties, we need all the models to specify the same metadata for a given output. If your model returns one of the outputs defined in this documentation, then it should follow the metadata structure described here.

For other kinds of outputs, you are free to use any relevant metadata structure, but if multiple people are producing the same kind of outputs, they are encouraged to come together, define the metadata schema they need and add a new section to these pages.

Physical quantities

The first set of standardized outputs for metatomic models are physical quantities, i.e. quantities with a well-defined physical meaning.

Energy
../_images/energy-output.png

The potential energy associated with a given system configuration. This can be used to run molecular simulations with on machine learning based interatomic potentials.

Energy
Energy ensemble
../_images/energy-ensemble-output.png

An ensemble of multiple potential energy predictions, generated when running multiple models simultaneously.

Energy ensemble
Energy uncertainty
../_images/energy-uncertainty-output.png

The uncertainty on the potential energies, useful to quantify the confidence of the model.

Energy uncertainty
Non-conservative forces
../_images/nc-forces-output.png

Forces directly predicted by the model, not derived from the potential energy.

Non-conservative forces
Non-conservative stress
../_images/nc-stress-output.png

Stress directly predicted by the model, not derived from the potential energy.

Non-conservative stress

Machine learning outputs

The next set of standardized outputs in metatomic models are specific to machine learning and related tools.

Features
../_images/features-output.png

Features are numerical vectors representing a given structure or atomic environment in an abstract n-dimensional space.

Features