deepmd.pt.model.task.invar_fitting

Attributes

dtype
device
log

Classes

InvarFitting

Construct a fitting net for energy.

Module Contents

deepmd.pt.model.task.invar_fitting.dtype

deepmd.pt.model.task.invar_fitting.device

deepmd.pt.model.task.invar_fitting.log

class deepmd.pt.model.task.invar_fitting.InvarFitting(var_name: str, ntypes: int, dim_descrpt: int, dim_out: int, neuron: list[int] = [128, 128, 128], bias_atom_e: torch.Tensor | None = None, resnet_dt: bool = True, numb_fparam: int = 0, numb_aparam: int = 0, activation_function: str = 'tanh', precision: str = DEFAULT_PRECISION, mixed_types: bool = True, rcond: float | None = None, seed: int | list[int] | None = None, exclude_types: list[int] = [], atom_ener: list[torch.Tensor | None] | None = None, type_map: list[str] | None = None, use_aparam_as_mask: bool = False, **kwargs)

Bases: deepmd.pt.model.task.fitting.GeneralFitting

Construct a fitting net for energy.

Parameters:

var_namestr

The atomic property to fit, ‘energy’, ‘dipole’, and ‘polar’.

ntypesint

Element count.

dim_descrptint

Embedding width per atom.

dim_outint

The output dimension of the fitting net.

neuronlist[int]

Number of neurons in each hidden layers of the fitting net.

bias_atom_etorch.Tensor, optional

Average energy per atom for each element.

resnet_dtbool

Using time-step in the ResNet construction.

numb_fparamint

Number of frame parameters.

numb_aparamint

Number of atomic parameters.

activation_functionstr

Activation function.

precisionstr

Numerical precision.

mixed_typesbool

If true, use a uniform fitting net for all atom types, otherwise use different fitting nets for different atom types.

rcondfloat, optional

The condition number for the regression of atomic energy.

seedint, optional

Random seed.

exclude_types: list[int]

Atomic contributions of the excluded atom types are set zero.

atom_ener: list[Optional[torch.Tensor]], optional

Specifying atomic energy contribution in vacuum. The value is a list specifying the bias. the elements can be None or np.array of output shape. For example: [None, [2.]] means type 0 is not set, type 1 is set to [2.] The set_davg_zero key in the descriptor should be set.

type_map: list[str], Optional

A list of strings. Give the name to each type of atoms.

use_aparam_as_mask: bool

If True, the aparam will not be used in fitting net for embedding.

dim_out

atom_ener

_net_out_dim()

Set the FittingNet output dim.

serialize() → dict

Serialize the fitting to dict.

classmethod deserialize(data: dict) → deepmd.pt.model.task.fitting.GeneralFitting

Deserialize the fitting.

Parameters:

datadict

The serialized data

Returns:

BF

The deserialized fitting

output_def() → deepmd.dpmodel.FittingOutputDef

Returns the output def of the fitting net.

forward(descriptor: torch.Tensor, atype: torch.Tensor, gr: torch.Tensor | None = None, g2: torch.Tensor | None = None, h2: torch.Tensor | None = None, fparam: torch.Tensor | None = None, aparam: torch.Tensor | None = None)

Based on embedding net output, alculate total energy.

Args: - inputs: Embedding matrix. Its shape is [nframes, natoms[0], self.dim_descrpt]. - natoms: Tell atom count and element count. Its shape is [2+self.ntypes].

Returns:

• torch.Tensor: Total energy with shape [nframes, natoms[0]].

exclude_types: list[int]