Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add intro.md #2521

Merged
merged 8 commits into from
Mar 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/development/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ You may find the guides for building and testing each engine as below.

### Build Coordinator

### Build Python Client

TODO(yuansi):

### Build Python Client
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ and the vineyard store that offers efficient in-memory data transfers.
:maxdepth: 2
:caption: Overview

graphscope_positioning
overview/intro
overview/getting_started
overview/graph_analytics_workloads
overview/graph_interactive_workloads
overview/graph_learning_workloads
overview/design_of_graphscope
overview/positioning
overview/glossary
release_notes
frequently_asked_questions
Expand Down
46 changes: 46 additions & 0 deletions docs/overview/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Introducing GraphScope

## What is GraphScope

GraphScope is a unified graph computing platform that provides a one-stop solution for graph computing. It provides a unified programming model for both graph analytics and graph neural networks, and supports a variety of graph data formats, including property graphs, heterogeneous graphs, and relational graphs. GraphScope also provides a unified runtime engine that can run both graph analytics and graph neural networks on a single cluster.

## Why use GraphScope

GraphScope has several advantages:

- **Performance:** GraphScope outperforms other state-of-the-art systems by 2X to magnitudes. Additionally, it provides a set of optimized built-in graph algorithms for out-of-the-box use.

- **Compatibility**: It supports Gremlin and Cypher(coming soon) for quering graph, and NetworkX compatible APIs for graph analytcis.

- **Integration to PyData:** GraphScope provides a user-friendly Python interface, making it easy to integrate with other PyData frameworks and manage complex workflows that involve multiple stages beyond graph processing.

- **Cloud Native:** which enabling it to be easily deployed on Kubernetes and providing good elasticity and scalability.


## What are the Use Cases

GraphScope can be used for various purposes:

- **For Offline Graph Analytical Jobs:** These jobs are usually iterative graph computation jobs that require multiple rounds of computation, e.g., pagerank, centrality, community detection, and graph clustering. You can use either built-in algorithms or plug-in customized algorithms, and run them over large graphs.

- **For Online Graph BI Analysis:** You can use GraphScope for interactive graph analysis, which usually complex graph queries written in Gremlin or Cypher, the concurrency is unlikely to be high, but the latency for complex queries is the key concern.

- **For High QPS Graph Queries:** You can also process graph queries coming at an extremely high rate and demand high throughput.

- **For Graph Neural Network Training and Inference:** GraphScope supports large-scale GNN and easily integrates with PyG/TensorFlow.

- **One-stop Graph Processing**: For a complex workflow that involves multiple stages of graph analytics, graph queries and GNNs, even beyond graph processing.


## What are the Limitations

- **GraphScope is not a graph database:** A graph database stores and manages data in a graph format, and provides ACID and transactions. While GraphScope focuses on analyzing and computing large-scale graphs using distributed computing. Refer to [Positioning of GraphScope](overview/positioning.md) for more details.

- **Security issue:** Currently, GraphScope lacks important security features such as authentication and encryption.

## What are the Next

You may want to

- [Get Started](overview/getting_started.md) with GraphScope;
- Learn more about the [Design of GraphScope](overview/design_of_graphscope.md);
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The Product Positioning of GraphScope
# Positioning of GraphScope

[GraphScope](./overview.md) is an open-source, cloud-native computing framework for a variety of graph workloads,
including analytical processing, interactive querying and graph learning. But how does GraphScope stand out
Expand All @@ -13,9 +13,7 @@ is the ideal platform.
We elaborate in details in the following.

## Compare with Graph Processing Systems
Most large-scale graph processing systems, including [PowerGraph](https://github.com/jegonzal/PowerGraph)(commit a038f97
) [GeminiGraph](https://github.com/thu-pacman/GeminiGraph)(commit 170e7d3
) and [Plato](https://github.com/Tencent/plato)(commit 21009d6), handles only the graph analytical processing workloads.
Most large-scale graph processing systems, including [PowerGraph](https://github.com/jegonzal/PowerGraph), [GeminiGraph](https://github.com/thu-pacman/GeminiGraph) and [Plato](https://github.com/Tencent/plato), handles only the graph analytical processing workloads.
Our [empirical studies](./performance_and_benchmark.md) via the LDBC [Graphalytics](http://graphalytics.org/) benchmark
have demonstrated that GraphScope outperforms these systems in all algorithms.
Furthermore, GraphScope has the added advantages of supporting a range of SDKs and programming interfaces for graph analytics:
Expand Down