From 85af19a621a4b01dadfa11b3a14b2dd3ed79666c Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Wed, 8 Nov 2023 16:27:39 -0500 Subject: [PATCH] update documentation Signed-off-by: Jinzhe Zeng --- deepmd_utils/__init__.py | 6 +++--- deepmd_utils/main.py | 5 +++++ 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/deepmd_utils/__init__.py b/deepmd_utils/__init__.py index d295053965..1c5314bb7e 100644 --- a/deepmd_utils/__init__.py +++ b/deepmd_utils/__init__.py @@ -1,6 +1,6 @@ # SPDX-License-Identifier: LGPL-3.0-or-later -"""This module contains the entry points for DeePMD-kit. +"""Untilization methods 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. +The __init__ module should not import any modules +for performance. """ diff --git a/deepmd_utils/main.py b/deepmd_utils/main.py index f2887d6f6e..3dc54db052 100644 --- a/deepmd_utils/main.py +++ b/deepmd_utils/main.py @@ -1,4 +1,9 @@ # SPDX-License-Identifier: LGPL-3.0-or-later +"""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. +""" import argparse import logging import textwrap