deepmd.dpmodel.atomic_model.energy_atomic_model

deepmd.dpmodel.atomic_model.energy_atomic_model#

Classes#

DPEnergyAtomicModel

Model give atomic prediction of some physical property.

Module Contents#

class deepmd.dpmodel.atomic_model.energy_atomic_model.DPEnergyAtomicModel(descriptor: Any, fitting: Any, type_map: list[str], **kwargs: Any)[source]#

Bases: deepmd.dpmodel.atomic_model.dp_atomic_model.DPAtomicModel

Model give atomic prediction of some physical property.

The atomic model computes atomic properties by first extracting a descriptor from the atomic environment, then passing it through a fitting network:

\[\mathcal{D}^i = \mathcal{D}(\mathbf{R}^i, \mathbf{R}_j, \alpha_j),\]
\[\mathbf{y}^i = \mathcal{F}(\mathcal{D}^i),\]

where \(\mathcal{D}^i\) is the descriptor for atom \(i\), \(\alpha_j\) is the atom type of neighbor \(j\), \(\mathcal{F}\) is the fitting network, and \(\mathbf{y}^i\) is the predicted atomic property (energy, dipole, etc.).

Parameters:
descriptor

Descriptor

fitting_net

Fitting net

type_map

Mapping atom type to the name (str) of the type. For example type_map[1] gives the name of the type 1.