deepmd.tf.entrypoints.main

DeePMD-Kit entry point module.

Module Contents

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([args])

DeePMD-Kit entry point.

deepmd.tf.entrypoints.main.get_ll(log_level: str) int[source]

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

deepmd.tf.entrypoints.main.main_parser() argparse.ArgumentParser[source]

DeePMD-Kit commandline options argument parser.

Returns:
argparse.ArgumentParser

main parser of DeePMD-kit

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

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.tf.entrypoints.main.main(args: List[str] | argparse.Namespace | None = None)[source]

DeePMD-Kit entry point.

Parameters:
argsList[str] or argparse.Namespace, optional

list of command line arguments, used to avoid calling from the subprocess, as it is quite slow to import tensorflow; if Namespace is given, it will be used directly

Raises:
RuntimeError

if no command was input