Skip to content

Commit be9e82f

Browse files
authored
update tutorials and helm readme (alibaba#232)
1 parent 11b5fab commit be9e82f

13 files changed

+62
-72
lines changed

charts/graphscope/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ GraphScope charts
88
## Get Repo Info
99

1010
```shell
11-
$ helm repo add graphscope https://dl.bintray.com/graphscope/charts/
11+
$ helm repo add graphscope https://graphscope.oss-cn-beijing.aliyuncs.com/charts/
1212
$ helm repo update
1313
```
1414
See [*helm repo*](https://helm.sh/docs/helm/helm_repo/) for command documentation.

tutorials/2_loading_graphs.ipynb

+13-9
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
"}\n",
5656
"\n",
5757
"graphscope.set_option(show_log=True) # enable logging\n",
58+
"graphscope.set_option(initializing_interactive_engine=False)\n",
5859
"sess = graphscope.session(k8s_volumes=k8s_volumes, k8s_etcd_mem='512Mi') # create a session"
5960
]
6061
},
@@ -68,10 +69,10 @@
6869
"\n",
6970
"These are the methods we will use to build a graph.\n",
7071
"```python\n",
71-
" def add_vertices(self, vertices, label=\"_\", properties=[], vid_field=0):\n",
72+
" def add_vertices(self, vertices, label=\"_\", properties=None, vid_field=0):\n",
7273
" pass\n",
7374
"\n",
74-
" def add_edges(self, edges, label=\"_\", properties=[], src_label=None, dst_label=None, src_field=0, dst_field=1):\n",
75+
" def add_edges(self, edges, label=\"_\", properties=None, src_label=None, dst_label=None, src_field=0, dst_field=1):\n",
7576
" pass\n",
7677
"```\n",
7778
"\n",
@@ -124,6 +125,7 @@
124125
"graph = graph.add_vertices(\n",
125126
" # source file for vertices labeled as person; \n",
126127
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"),\n",
128+
" \"person\",\n",
127129
" # columns loaded as property\n",
128130
" [\"firstName\", \"lastName\"],\n",
129131
" # The column used as vertex ID\n",
@@ -245,7 +247,7 @@
245247
"graph = sess.g()\n",
246248
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
247249
"graph = graph.add_edges(\n",
248-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
250+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
249251
" \"knows\",\n",
250252
" src_label=\"person\",\n",
251253
" dst_label=\"person\",\n",
@@ -270,7 +272,7 @@
270272
"graph = sess.g()\n",
271273
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
272274
"graph = graph.add_edges(\n",
273-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
275+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
274276
" \"knows\",\n",
275277
" src_label=\"person\",\n",
276278
" dst_label=\"person\"\n",
@@ -293,7 +295,7 @@
293295
"graph = sess.g()\n",
294296
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
295297
"graph = graph.add_edges(\n",
296-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
298+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
297299
" \"knows\"\n",
298300
")"
299301
]
@@ -320,7 +322,7 @@
320322
"source": [
321323
"graph = sess.g()\n",
322324
"graph = graph.add_edges(\n",
323-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
325+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
324326
" \"knows\"\n",
325327
")"
326328
]
@@ -341,15 +343,17 @@
341343
"graph = sess.g()\n",
342344
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
343345
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/post_0_0.csv\", delimiter=\"|\"), label=\"post\")\n",
344-
"\n",
346+
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/comment_0_0.csv\", delimiter=\"|\"), label=\"comment\")\n",
345347
"graph = graph.add_edges(\n",
346348
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_likes_comment_0_0.csv\", delimiter=\"|\"),\n",
349+
" \"comment\",\n",
347350
" [\"creationDate\"],\n",
348351
" src_label=\"person\",\n",
349-
" dst_label=\"person\"\n",
352+
" dst_label=\"comment\"\n",
350353
")\n",
351354
"graph = graph.add_edges(\n",
352355
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_likes_post_0_0.csv\", delimiter=\"|\"),\n",
356+
" \"likes\",\n",
353357
" [\"creationDate\"],\n",
354358
" src_label=\"person\",\n",
355359
" dst_label=\"post\"\n",
@@ -700,4 +704,4 @@
700704
},
701705
"nbformat": 4,
702706
"nbformat_minor": 4
703-
}
707+
}

tutorials/3_builtin_analytical_algorithms.ipynb

+5-4
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,12 @@
4848
"}\n",
4949
"\n",
5050
"graphscope.set_option(show_log=True) # enable logging\n",
51+
"graphscope.set_option(initializing_interactive_engine=False)\n",
5152
"sess = graphscope.session(k8s_volumes=k8s_volumes)\n",
5253
"\n",
5354
"graph = sess.g(directed=False)\n",
5455
"graph = graph.add_vertices(\"/home/jovyan/datasets/property/p2p-31_property_v_0\", label=\"person\")\n",
55-
"graph = graph.add_edges(\"/home/jovyan/datasets/property/p2p-31_property_v_0\", label=\"knows\")"
56+
"graph = graph.add_edges(\"/home/jovyan/datasets/property/p2p-31_property_e_0\", label=\"knows\")"
5657
]
5758
},
5859
{
@@ -87,8 +88,8 @@
8788
"Most graph analytical algorithms are defined on **simple graph**, which has only \n",
8889
"one kind of vertices and edges, edges and vertices have at most one property as its attribute.\n",
8990
"\n",
90-
"GraphScope provides a function `project_to_simple` to convert a property graph to a simple, by selecting\n",
91-
" one kind of label for vertices/edges, and each with one of their properties."
91+
"GraphScope provides a function `project` to convert a property graph to a simple graph, by selecting\n",
92+
" one kind of label for vertices/edges, and each with at most one of their properties."
9293
]
9394
},
9495
{
@@ -297,4 +298,4 @@
297298
},
298299
"nbformat": 4,
299300
"nbformat_minor": 4
300-
}
301+
}

tutorials/4_writing_your_own_algorithms.ipynb

+4-4
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@
306306
"\n",
307307
"graph = sess.g(directed=False)\n",
308308
"graph = graph.add_vertices(\"/home/jovyan/datasets/property/p2p-31_property_v_0\", label=\"person\")\n",
309-
"graph = graph.add_edges(\"/home/jovyan/datasets/property/p2p-31_property_v_0\", label=\"knows\")"
309+
"graph = graph.add_edges(\"/home/jovyan/datasets/property/p2p-31_property_e_0\", label=\"knows\")"
310310
]
311311
},
312312
{
@@ -323,7 +323,7 @@
323323
"outputs": [],
324324
"source": [
325325
"sssp = SSSP_PIE()\n",
326-
"ctx = sssp(g, src=6)"
326+
"ctx = sssp(graph, src=6)"
327327
]
328328
},
329329
{
@@ -596,7 +596,7 @@
596596
"outputs": [],
597597
"source": [
598598
"sssp_pregel = SSSP_Pregel()\n",
599-
"ctx = sssp_pregel(g, src=6)"
599+
"ctx = sssp_pregel(graph, src=6)"
600600
]
601601
},
602602
{
@@ -740,4 +740,4 @@
740740
},
741741
"nbformat": 4,
742742
"nbformat_minor": 4
743-
}
743+
}

tutorials/5_interactive_query_with_gremlin.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@
4141
"graphscope.set_option(show_log=True) # enable logging\n",
4242
"session = graphscope.session(k8s_volumes=k8s_volumes) # create a session\n",
4343
"\n",
44-
"modern_graph = sess.g()\n",
44+
"modern_graph = session.g()\n",
4545
"modern_graph = modern_graph.add_vertices(\n",
4646
" Loader(\"/home/jovyan/datasets/modern_graph_2/person.csv\", delimiter=\"|\"),\n",
4747
" label=\"person\"\n",
4848
")\n",
4949
"modern_graph = modern_graph.add_vertices(\n",
5050
" Loader(\"/home/jovyan/datasets/modern_graph_2/software.csv\", delimiter=\"|\"),\n",
51-
" label=\"person\"\n",
51+
" label=\"software\"\n",
5252
")\n",
5353
"modern_graph = modern_graph.add_edges(\n",
5454
" Loader(\"/home/jovyan/datasets/modern_graph_2/knows.csv\", delimiter=\"|\"),\n",
@@ -177,4 +177,4 @@
177177
},
178178
"nbformat": 4,
179179
"nbformat_minor": 4
180-
}
180+
}

tutorials/8_node_classification_on_citation_network.ipynb

+2-4
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@
1919
]
2020
},
2121
{
22-
"cell_type": "code",
23-
"execution_count": null,
22+
"cell_type": "markdown",
2423
"metadata": {},
25-
"outputs": [],
2624
"source": [
2725
"First, let's create a session and load obgn_mag dataset as a graph."
2826
]
@@ -245,4 +243,4 @@
245243
},
246244
"nbformat": 4,
247245
"nbformat_minor": 4
248-
}
246+
}

tutorials/Welcome.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
{
4949
"data": {
5050
"text/plain": [
51-
"'0.1.3'"
51+
"'0.3.0'"
5252
]
5353
},
5454
"execution_count": 2,
@@ -106,4 +106,4 @@
106106
},
107107
"nbformat": 4,
108108
"nbformat_minor": 4
109-
}
109+
}

tutorials/zh/2_loading_graphs.ipynb

+18-28
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
"}\n",
6565
"\n",
6666
"graphscope.set_option(show_log=True) # enable logging\n",
67+
"graphscope.set_option(initializing_interactive_engine=False)\n",
6768
"sess = graphscope.session(k8s_volumes=k8s_volumes, k8s_etcd_mem='512Mi') # create a session"
6869
]
6970
},
@@ -77,21 +78,19 @@
7778
"这是我们接下来将要用到的建图方法。\n",
7879
"\n",
7980
"```python\n",
80-
" def add_vertices(self, vertices, label=\"_\", properties=[], vid_field=0):\n",
81+
" def add_vertices(self, vertices, label=\"_\", properties=None, vid_field=0):\n",
8182
" pass\n",
8283
"\n",
83-
" def add_edges(self, edges, label=\"_\", properties=[], src_label=None, dst_label=None, src_field=0, dst_field=1):\n",
84+
" def add_edges(self, edges, label=\"_\", properties=None, src_label=None, dst_label=None, src_field=0, dst_field=1):\n",
8485
" pass\n",
8586
"```\n",
8687
"\n",
8788
"接下来,我们将介绍这些方法,并且展示其用法。"
8889
]
8990
},
9091
{
91-
"cell_type": "code",
92-
"execution_count": null,
92+
"cell_type": "markdown",
9393
"metadata": {},
94-
"outputs": [],
9594
"source": [
9695
"### 建立图\n",
9796
"\n",
@@ -136,6 +135,7 @@
136135
"graph = graph.add_vertices(\n",
137136
" # source file for vertices labeled as person; \n",
138137
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"),\n",
138+
" \"person\",\n",
139139
" # columns loaded as property\n",
140140
" [\"firstName\", \"lastName\"],\n",
141141
" # The column used as vertex ID\n",
@@ -261,7 +261,7 @@
261261
"graph = sess.g()\n",
262262
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
263263
"graph = graph.add_edges(\n",
264-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
264+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
265265
" \"knows\",\n",
266266
" src_label=\"person\",\n",
267267
" dst_label=\"person\",\n",
@@ -286,7 +286,7 @@
286286
"graph = sess.g()\n",
287287
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
288288
"graph = graph.add_edges(\n",
289-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
289+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
290290
" \"knows\",\n",
291291
" src_label=\"person\",\n",
292292
" dst_label=\"person\"\n",
@@ -309,7 +309,7 @@
309309
"graph = sess.g()\n",
310310
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
311311
"graph = graph.add_edges(\n",
312-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
312+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
313313
" \"knows\"\n",
314314
")"
315315
]
@@ -336,7 +336,7 @@
336336
"source": [
337337
"graph = sess.g()\n",
338338
"graph = graph.add_edges(\n",
339-
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimieter=\"|\"),\n",
339+
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_knows_person_0_0.csv\", delimiter=\"|\"),\n",
340340
" \"knows\"\n",
341341
")"
342342
]
@@ -357,15 +357,17 @@
357357
"graph = sess.g()\n",
358358
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/person_0_0.csv\", delimiter=\"|\"), label=\"person\")\n",
359359
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/post_0_0.csv\", delimiter=\"|\"), label=\"post\")\n",
360-
"\n",
360+
"graph = graph.add_vertices(Loader(\"/home/jovyan/datasets/ldbc_sample/comment_0_0.csv\", delimiter=\"|\"), label=\"comment\")\n",
361361
"graph = graph.add_edges(\n",
362362
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_likes_comment_0_0.csv\", delimiter=\"|\"),\n",
363+
" \"comment\",\n",
363364
" [\"creationDate\"],\n",
364365
" src_label=\"person\",\n",
365-
" dst_label=\"person\"\n",
366+
" dst_label=\"comment\"\n",
366367
")\n",
367368
"graph = graph.add_edges(\n",
368369
" Loader(\"/home/jovyan/datasets/ldbc_sample/person_likes_post_0_0.csv\", delimiter=\"|\"),\n",
370+
" \"likes\",\n",
369371
" [\"creationDate\"],\n",
370372
" src_label=\"person\",\n",
371373
" dst_label=\"post\"\n",
@@ -458,21 +460,9 @@
458460
},
459461
{
460462
"cell_type": "code",
461-
"execution_count": 4,
462-
"metadata": {},
463-
"outputs": [
464-
{
465-
"ename": "NameError",
466-
"evalue": "name 'graph' is not defined",
467-
"output_type": "error",
468-
"traceback": [
469-
"\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
470-
"\u001b[0;31mNameError\u001b[0m Traceback (most recent call last)",
471-
"\u001b[0;32m<ipython-input-4-0dd6a629fd41>\u001b[0m in \u001b[0;36m<module>\u001b[0;34m\u001b[0m\n\u001b[0;32m----> 1\u001b[0;31m \u001b[0mgraph\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0mserialize\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m'/tmp/seri'\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m",
472-
"\u001b[0;31mNameError\u001b[0m: name 'graph' is not defined"
473-
]
474-
}
475-
],
463+
"execution_count": null,
464+
"metadata": {},
465+
"outputs": [],
476466
"source": [
477467
"graph.save_to('/tmp/seri')"
478468
]
@@ -715,9 +705,9 @@
715705
"name": "python",
716706
"nbconvert_exporter": "python",
717707
"pygments_lexer": "ipython3",
718-
"version": "3.7.9"
708+
"version": "3.8.6"
719709
}
720710
},
721711
"nbformat": 4,
722712
"nbformat_minor": 4
723-
}
713+
}

tutorials/zh/3_builtin_analytical_algorithms.ipynb

+4-5
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"\n",
5454
"graph = sess.g(directed=False)\n",
5555
"graph = graph.add_vertices(\"/home/jovyan/datasets/property/p2p-31_property_v_0\", label=\"person\")\n",
56-
"graph = graph.add_edges(\"/home/jovyan/datasets/property/p2p-31_property_v_0\", label=\"knows\")"
56+
"graph = graph.add_edges(\"/home/jovyan/datasets/property/p2p-31_property_e_0\", label=\"knows\")"
5757
]
5858
},
5959
{
@@ -111,7 +111,7 @@
111111
"\n",
112112
"许多图分析算法都只能查询 **简单图**, 在这里我们定义 **简单图** 为只包含一种点和一种边,且点和边最多只有一个属性。\n",
113113
"\n",
114-
"`GraphScope` 提供了一个函数 `project_to_simple` 来将属性图投影为简单图,我们可以选择某一种点和边,以及其属性,来获得属性图的一个 **投影**。"
114+
"`GraphScope` 提供了一个函数 `project` 来将属性图投影为简单图,我们可以选择某一种点和边,以及其一个或零个属性,来获得属性图的一个 **投影**。"
115115
]
116116
},
117117
{
@@ -129,8 +129,7 @@
129129
}
130130
],
131131
"source": [
132-
"simple_graph = graph.project(vertices={\"person\": []},\n",
133-
"edges={\"knows\": [\"dist\"]})"
132+
"simple_graph = graph.project(vertices={\"person\": []}, edges={\"knows\": [\"dist\"]})"
134133
]
135134
},
136135
{
@@ -602,4 +601,4 @@
602601
},
603602
"nbformat": 4,
604603
"nbformat_minor": 4
605-
}
604+
}

0 commit comments

Comments
 (0)