Skip to content

Commit

Permalink
Add graphscope module level doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
siyuan0322 committed Feb 2, 2021
1 parent 512a5b8 commit 129722f
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions python/graphscope/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""

0 comments on commit 129722f

Please sign in to comment.