diff --git a/python/graphscope/__init__.py b/python/graphscope/__init__.py index be8e4e889c4a..7ececfd15cb8 100644 --- a/python/graphscope/__init__.py +++ b/python/graphscope/__init__.py @@ -29,3 +29,22 @@ from graphscope.framework.graph_utils import g from graphscope.framework.graph_utils import load_from from graphscope.version import __version__ + +# module level doc-string +__doc__ = """ +GraphScope - A unified distributed graph computing platform +===================================================================== + +GraphScope provides a one-stop environment for performing diverse graph operations on a cluster of computers through a user-friendly Python interface. GraphScope makes multi-staged processing of large-scale graph data on compute clusters simple by combining several important pieces of Alibaba technology: including GRAPE, MaxGraph, and Graph-Learn (GL) for analytics, interactive, and graph neural networks (GNN) computation, respectively, and the vineyard store that offers efficient in-memory data transfers. + +Main Components +--------------- + +Here are the main components that GraphScope includes: + + - GIE: a parallel interactive engine for graph traversal + + - GAE: a high-performance graph analytics engine + + - GLE: an end-to-end graph learning framework +"""