deepmd.utils.compat

Module providing compatibility between 0.x.x and 1.x.x input versions.

Functions

convert_input_v0_v1(→ dict[str, Any])	Convert input from v0 format to v1.
_warning_input_v0_v1(→ None)
_model(→ dict[str, dict[str, Any]])	Convert data to v1 input for non-smooth model.
_nonsmth_descriptor(→ dict[str, Any])	Convert data to v1 input for non-smooth descriptor.
_smth_descriptor(→ dict[str, Any])	Convert data to v1 input for smooth descriptor.
_fitting_net(→ dict[str, Any])	Convert data to v1 input for fitting net.
_learning_rate(→ dict[str, Any])	Convert data to v1 input for learning rate section.
_loss(→ dict[str, Any])	Convert data to v1 input for loss function.
_training(→ dict[str, Any])	Convert data to v1 input for training.
_jcopy(→ None)	Copy specified keys from one dict to another.
remove_decay_rate(→ None)	Convert decay_rate to stop_lr.
convert_input_v1_v2(→ dict[str, Any])
_warning_input_v1_v2(→ None)
deprecate_numb_test(→ dict[str, Any])	Deprecate numb_test since v2.1. It has taken no effect since v2.0.
update_deepmd_input(→ dict[str, Any])

Module Contents

deepmd.utils.compat.convert_input_v0_v1(jdata: dict[str, Any], warning: bool = True, dump: str | pathlib.Path | None = None) → dict[str, Any]

Convert input from v0 format to v1.

Parameters:

jdatadict[str, Any]

loaded json/yaml file

warningbool, optional

whether to show deprecation warning, by default True

dumpOptional[Union[str, Path]], optional

whether to dump converted file, by default None

Returns:

dict[str, Any]

converted output

deepmd.utils.compat._warning_input_v0_v1(fname: str | pathlib.Path | None) → None

deepmd.utils.compat._model(jdata: dict[str, Any], smooth: bool) → dict[str, dict[str, Any]]

Convert data to v1 input for non-smooth model.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

smoothbool

whether to use smooth or non-smooth descriptor version

Returns:

dict[str, dict[str, Any]]

dictionary with model input parameters and sub-dictionaries for descriptor and fitting net

deepmd.utils.compat._nonsmth_descriptor(jdata: dict[str, Any]) → dict[str, Any]

Convert data to v1 input for non-smooth descriptor.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

Returns:

dict[str, Any]

dict with descriptor parameters

deepmd.utils.compat._smth_descriptor(jdata: dict[str, Any]) → dict[str, Any]

Convert data to v1 input for smooth descriptor.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

Returns:

dict[str, Any]

dict with descriptor parameters

deepmd.utils.compat._fitting_net(jdata: dict[str, Any]) → dict[str, Any]

Convert data to v1 input for fitting net.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

Returns:

dict[str, Any]

dict with fitting net parameters

deepmd.utils.compat._learning_rate(jdata: dict[str, Any]) → dict[str, Any]

Convert data to v1 input for learning rate section.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

Returns:

dict[str, Any]

dict with learning rate parameters

deepmd.utils.compat._loss(jdata: dict[str, Any]) → dict[str, Any]

Convert data to v1 input for loss function.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

Returns:

dict[str, Any]

dict with loss function parameters

deepmd.utils.compat._training(jdata: dict[str, Any]) → dict[str, Any]

Convert data to v1 input for training.

Parameters:

jdatadict[str, Any]

parsed input json/yaml data

Returns:

dict[str, Any]

dict with training parameters

deepmd.utils.compat._jcopy(src: dict[str, Any], dst: dict[str, Any], keys: collections.abc.Sequence[str]) → None

Copy specified keys from one dict to another.

Parameters:

srcdict[str, Any]

source dictionary

dstdict[str, Any]

destination dictionary, will be modified in place

keysSequence[str]

list of keys to copy

deepmd.utils.compat.remove_decay_rate(jdata: dict[str, Any]) → None

Convert decay_rate to stop_lr.

Parameters:

jdatadict[str, Any]

input data

deepmd.utils.compat.convert_input_v1_v2(jdata: dict[str, Any], warning: bool = True, dump: str | pathlib.Path | None = None) → dict[str, Any]

deepmd.utils.compat._warning_input_v1_v2(fname: str | pathlib.Path | None) → None

deepmd.utils.compat.deprecate_numb_test(jdata: dict[str, Any], warning: bool = True, dump: str | pathlib.Path | None = None) → dict[str, Any]

Deprecate numb_test since v2.1. It has taken no effect since v2.0.

See #1243.

Parameters:

jdatadict[str, Any]

loaded json/yaml file

warningbool, optional

whether to show deprecation warning, by default True

dumpOptional[Union[str, Path]], optional

whether to dump converted file, by default None

Returns:

dict[str, Any]

converted output

deepmd.utils.compat.update_deepmd_input(jdata: dict[str, Any], warning: bool = True, dump: str | pathlib.Path | None = None) → dict[str, Any]