Skip to content

Commit

Permalink
Add a TOC to the README. (#1838)
Browse files Browse the repository at this point in the history
Signed-off-by: Tao He <linzhu.ht@alibaba-inc.com>
  • Loading branch information
sighingnow committed Jul 13, 2022
1 parent 1d92227 commit 5698d98
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,29 @@ GraphScope is a unified distributed graph computing platform that provides a one

Visit our website at [graphscope.io](https://graphscope.io) to learn more.

## Table of Contents

- [Getting Started](#getting-started)
- [Installation for Standalone Mode](#installation-for-standalone-mode)
- [Demo: Node Classification on Citation Network](#demo-node-classification-on-citation-network)
- [Loading a graph](#loading-a-graph)
- [Interactive query](#interactive-query)
- [Graph analytics](#graph-analytics)
- [Graph neural networks (GNNs)](#graph-neural-networks-gnns)
- [Graph Processing on Kubernetes](#processing-large-graph-on-kubernetes-cluster)
- [Creating a session](#creating-a-session)
- [Loading graphs and graph computation](#loading-a-graph-and-processing-computation-tasks)
- [Closing the session](#closing-the-session)
- [Development](#development)
- [Building from source](#building-on-local)
- [Building Docker images](#building-docker-images)
- [Building the client library](#building-client-library)
- [Testing](#testing)
- [Documentation](#documentation)
- [License](#license)
- [Publications](#publications)
- [Joining our Community!](#contributing)

## Getting Started

We provide a [Playground](https://try.graphscope.app) with a managed JupyterLab. [Try GraphScope](https://try.graphscope.app) straight away in your browser!
Expand Down Expand Up @@ -210,7 +233,7 @@ train(config, lg)
A python script with the entire process is availabe [here](https://colab.research.google.com/github/alibaba/GraphScope/blob/main/tutorials/1_node_classification_on_citation.ipynb), you may try it out by yourself.


### Processing Large Graph on Kubernetes Cluster
## Processing Large Graph on Kubernetes Cluster

GraphScope is designed for processing large graphs, which are usually hard to fit in the memory of a single machine.
With [Vineyard](https://github.com/v6d-io/v6d) as the distributed in-memory data manager, GraphScope supports run on a cluster managed by Kubernetes(k8s).
Expand Down

0 comments on commit 5698d98

Please sign in to comment.