Skip to content

Commit

Permalink
move deepmd.entrypoints.{doc,gui} to deepmd_utils.entrypoints.{doc,gu…
Browse files Browse the repository at this point in the history
…i} (#3144)

See #3118

---------

Signed-off-by: Jinzhe Zeng <[email protected]>
  • Loading branch information
njzjz authored Jan 14, 2024
1 parent 539e4ab commit 89d9a88
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 45 deletions.
18 changes: 2 additions & 16 deletions deepmd/entrypoints/doc.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
"""Module that prints train input arguments docstrings."""

from deepmd.utils.argcheck import (
gen_doc,
gen_json,
from deepmd_utils.entrypoints.doc import (
doc_train_input,
)

__all__ = ["doc_train_input"]


def doc_train_input(*, out_type: str = "rst", **kwargs):
"""Print out trining input arguments to console."""
if out_type == "rst":
doc_str = gen_doc(make_anchor=True)
elif out_type == "json":
doc_str = gen_json()
else:
raise RuntimeError("Unsupported out type %s" % out_type)
print(doc_str)
33 changes: 4 additions & 29 deletions deepmd/entrypoints/gui.py
Original file line number Diff line number Diff line change
@@ -1,31 +1,6 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
"""DP-GUI entrypoint."""
from deepmd_utils.entrypoints.gui import (
start_dpgui,
)


def start_dpgui(*, port: int, bind_all: bool, **kwargs):
"""Host DP-GUI server.
Parameters
----------
port : int
The port to serve DP-GUI on.
bind_all : bool
Serve on all public interfaces. This will expose your DP-GUI instance
to the network on both IPv4 and IPv6 (where available).
**kwargs
additional arguments
Raises
------
ModuleNotFoundError
The dpgui package is not installed
"""
try:
from dpgui import (
start_dpgui,
)
except ModuleNotFoundError as e:
raise ModuleNotFoundError(
"To use DP-GUI, please install the dpgui package:\npip install dpgui"
) from e
start_dpgui(port=port, bind_all=bind_all)
__all__ = ["start_dpgui"]
1 change: 1 addition & 0 deletions deepmd_utils/entrypoints/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
20 changes: 20 additions & 0 deletions deepmd_utils/entrypoints/doc.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
"""Module that prints train input arguments docstrings."""

from deepmd_utils.utils.argcheck import (
gen_doc,
gen_json,
)

__all__ = ["doc_train_input"]


def doc_train_input(*, out_type: str = "rst", **kwargs):
"""Print out trining input arguments to console."""
if out_type == "rst":
doc_str = gen_doc(make_anchor=True)
elif out_type == "json":
doc_str = gen_json()
else:
raise RuntimeError("Unsupported out type %s" % out_type)
print(doc_str)
31 changes: 31 additions & 0 deletions deepmd_utils/entrypoints/gui.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
"""DP-GUI entrypoint."""


def start_dpgui(*, port: int, bind_all: bool, **kwargs):
"""Host DP-GUI server.
Parameters
----------
port : int
The port to serve DP-GUI on.
bind_all : bool
Serve on all public interfaces. This will expose your DP-GUI instance
to the network on both IPv4 and IPv6 (where available).
**kwargs
additional arguments
Raises
------
ModuleNotFoundError
The dpgui package is not installed
"""
try:
from dpgui import (
start_dpgui,
)
except ModuleNotFoundError as e:
raise ModuleNotFoundError(
"To use DP-GUI, please install the dpgui package:\npip install dpgui"
) from e
start_dpgui(port=port, bind_all=bind_all)

0 comments on commit 89d9a88

Please sign in to comment.