Skip to content

Commit

Permalink
docs: add NebulaGraph-Lite
Browse files Browse the repository at this point in the history
  • Loading branch information
wey-gu authored Mar 5, 2024
1 parent ad4aa79 commit 643574d
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ NebulaGraph NetworkX (ng_nx) is a tool that allows you to use the NetworkX API f

## Quick Start

Prepare for a NebulaGraph cluster within Colab in 5 mins following https://github.com/nebula-contrib/nebulagraph-lite.

### Install

```bash
Expand All @@ -49,10 +51,13 @@ from ng_nx.utils import NebulaGraphConfig

import networkx as nx

config = NebulaGraphConfig()
config = NebulaGraphConfig(
space="basketballplayer",
graphd_hosts="127.0.0.1:9669",
metad_hosts="127.0.0.1:9559"
)

reader = NebulaReader(
space="basketballplayer",
edges=["follow", "serve"],
properties=[["degree"], ["start_year", "end_year"]],
nebula_config=config, limit=10000)
Expand Down Expand Up @@ -121,4 +126,4 @@ louvain_writer.write()

## Documentation

[API Reference](https://github.com/wey-gu/nebulagraph-nx/blob/main/docs/API.md)
[API Reference](https://github.com/wey-gu/nebulagraph-nx/blob/main/docs/API.md)

0 comments on commit 643574d

Please sign in to comment.