deepmd.pt.loss.loss

Module Contents

Classes

TaskLoss

Base class for all neural network modules.

class deepmd.pt.loss.loss.TaskLoss(**kwargs)

Bases: torch.nn.Module, abc.ABC

Base class for all neural network modules.

Your models should also subclass this class.

Modules can also contain other Modules, allowing to nest them in a tree structure. You can assign the submodules as regular attributes:

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self):
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

Submodules assigned in this way will be registered, and will have their parameters converted too when you call to(), etc.

Note

As per the example above, an __init__() call to the parent class must be made before assignment on the child.

Variables:

training (bool) – Boolean represents whether this module is in training or evaluation mode.

abstract property label_requirement: List[deepmd.utils.data.DataRequirementItem]

Return data label requirements needed for this loss calculation.

abstract forward(input_dict, model, label, natoms, learning_rate)

Return loss .

static display_if_exist(loss: torch.Tensor, find_property: float) → torch.Tensor

Display NaN if labeled property is not found.

Parameters:

losstorch.Tensor

the loss tensor

find_propertyfloat

whether the property is found