deepmd.loss package

class deepmd.loss.EnerDipoleLoss(starter_learning_rate: float, start_pref_e: float = 0.1, limit_pref_e: float = 1.0, start_pref_ed: float = 1.0, limit_pref_ed: float = 1.0)

Bases: Loss

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

build(learning_rate, natoms, model_dict, label_dict, suffix)

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

eval(sess, feed_dict, natoms)

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms

class deepmd.loss.EnerStdLoss(starter_learning_rate: float, start_pref_e: float = 0.02, limit_pref_e: float = 1.0, start_pref_f: float = 1000, limit_pref_f: float = 1.0, start_pref_v: float = 0.0, limit_pref_v: float = 0.0, start_pref_ae: float = 0.0, limit_pref_ae: float = 0.0, start_pref_pf: float = 0.0, limit_pref_pf: float = 0.0, relative_f: float | None = None, enable_atom_ener_coeff: bool = False)

Bases: Loss

Standard loss function for DP models.

Parameters:

enable_atom_ener_coeffbool

if true, the energy will be computed as sum_i c_i E_i

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

build(learning_rate, natoms, model_dict, label_dict, suffix)

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

eval(sess, feed_dict, natoms)

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms

class deepmd.loss.TensorLoss(jdata, **kwarg)

Bases: Loss

Loss function for tensorial properties.

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

build(learning_rate, natoms, model_dict, label_dict, suffix)

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

eval(sess, feed_dict, natoms)

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms

Submodules

deepmd.loss.ener module

class deepmd.loss.ener.EnerDipoleLoss(starter_learning_rate: float, start_pref_e: float = 0.1, limit_pref_e: float = 1.0, start_pref_ed: float = 1.0, limit_pref_ed: float = 1.0)

Bases: Loss

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

build(learning_rate, natoms, model_dict, label_dict, suffix)

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

eval(sess, feed_dict, natoms)

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms

class deepmd.loss.ener.EnerStdLoss(starter_learning_rate: float, start_pref_e: float = 0.02, limit_pref_e: float = 1.0, start_pref_f: float = 1000, limit_pref_f: float = 1.0, start_pref_v: float = 0.0, limit_pref_v: float = 0.0, start_pref_ae: float = 0.0, limit_pref_ae: float = 0.0, start_pref_pf: float = 0.0, limit_pref_pf: float = 0.0, relative_f: float | None = None, enable_atom_ener_coeff: bool = False)

Bases: Loss

Standard loss function for DP models.

Parameters:

enable_atom_ener_coeffbool

if true, the energy will be computed as sum_i c_i E_i

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

build(learning_rate, natoms, model_dict, label_dict, suffix)

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

eval(sess, feed_dict, natoms)

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms

deepmd.loss.loss module

class deepmd.loss.loss.Loss

Bases: object

The abstract class for the loss function.

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

abstract build(learning_rate: Tensor, natoms: Tensor, model_dict: Dict[str, Tensor], label_dict: Dict[str, Tensor], suffix: str) → Tuple[Tensor, Dict[str, Tensor]]

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

abstract eval(sess: Session, feed_dict: Dict[placeholder, Tensor], natoms: Tensor) → dict

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms

deepmd.loss.tensor module

class deepmd.loss.tensor.TensorLoss(jdata, **kwarg)

Bases: Loss

Loss function for tensorial properties.

Methods

build(learning_rate, natoms, model_dict, ...)	Build the loss function graph.
eval(sess, feed_dict, natoms)	Eval the loss function.

build(learning_rate, natoms, model_dict, label_dict, suffix)

Build the loss function graph.

Parameters:

learning_ratetf.Tensor

learning rate

natomstf.Tensor

number of atoms

model_dictdict[str, tf.Tensor]

A dictionary that maps model keys to tensors

label_dictdict[str, tf.Tensor]

A dictionary that maps label keys to tensors

suffixstr

suffix

Returns:

tf.Tensor

the total squared loss

dict[str, tf.Tensor]

A dictionary that maps loss keys to more loss tensors

eval(sess, feed_dict, natoms)

Eval the loss function.

Parameters:

sesstf.Session

TensorFlow session

feed_dictdict[tf.placeholder, tf.Tensor]

A dictionary that maps graph elements to values

natomstf.Tensor

number of atoms

Returns:

dict

A dictionary that maps keys to values. It should contain key natoms