deepmd.main

The entry points for DeePMD-kit.

If only printing the help message, this module does not call the main DeePMD-kit module to avoid the slow import of TensorFlow.

Module Contents

Classes

RawTextArgumentDefaultsHelpFormatter	This formatter is used to print multile-line help message with default value.
BackendOption	Map backend alias to unique name.

Functions

get_ll(→ int)	Convert string to python logging level.
main_parser(→ argparse.ArgumentParser)	DeePMD-Kit commandline options argument parser.
parse_args(→ argparse.Namespace)	Parse arguments and convert argument strings to objects.
main()	DeePMD-kit new entry point.

Attributes

__version__
BACKENDS
BACKEND_TABLE

deepmd.main.__version__ = 'unknown'

deepmd.main.get_ll(log_level: str) → int

Convert string to python logging level.

Parameters:

log_levelstr

allowed input values are: DEBUG, INFO, WARNING, ERROR, 3, 2, 1, 0

Returns:

int

one of python logging module log levels - 10, 20, 30 or 40

class deepmd.main.RawTextArgumentDefaultsHelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter

This formatter is used to print multile-line help message with default value.

deepmd.main.BACKENDS: Dict[str, Type[deepmd.backend.backend.Backend]]

deepmd.main.BACKEND_TABLE: Dict[str, str]

class deepmd.main.BackendOption(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse.Action

Map backend alias to unique name.

__call__(parser, namespace, values, option_string=None)

deepmd.main.main_parser() → argparse.ArgumentParser

DeePMD-Kit commandline options argument parser.

Returns:

argparse.ArgumentParser

main parser of DeePMD-kit

deepmd.main.parse_args(args: List[str] | None = None) → argparse.Namespace

Parse arguments and convert argument strings to objects.

Parameters:

argsList[str]

list of command line arguments, main purpose is testing default option None takes arguments from sys.argv

Returns:

argparse.Namespace

the populated namespace

deepmd.main.main()

DeePMD-kit new entry point.

Raises:

RuntimeError

if no command was input