Skip to content

Commit d776981

Browse files
wey-guwey-gu
authored
chore: fixed readme formating (#57)
* chore: fixed readme formating * chore: wording * chore: wording for CN readme * update cn * revert en readme
1 parent 4c56fe5 commit d776981

File tree

2 files changed

+49
-46
lines changed

2 files changed

+49
-46
lines changed

‎README-CN.md‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -81,29 +81,30 @@ nebula-algorithm 是一款基于 [GraphX](https://spark.apache.org/graphx/) 的
8181
8282
> 注：执行算法的 DataFrame 默认第一列是源点，第二列是目标点，第三列是边权重。
8383
84-
## Nebula 中属性配置
85-
如果你想将算法结果写入到 Nebula，请确保 Nebula 的 tag 中有对应算法结果名称的属性。各项算法对应的属性名如下所示：
86-
87-
| Algorithm | property name |property type|
88-
|:------------------------:|:-----------------------:|:-----------:|
89-
| pagerank | pagerank |double/string|
90-
| louvain | louvain | int/string |
91-
| kcore | kcore | int/string |
92-
| labelpropagation | lpa | int/string |
93-
| connectedcomponent | cc | int/string |
94-
|stronglyconnectedcomponent| scc | int/string |
95-
| betweenness | betweenness |double/string|
96-
| shortestpath | shortestpath | string |
97-
| degreestatic |degree,inDegree,outDegree| int/string |
98-
| trianglecount | trianglecount | int/string |
99-
| clusteringcoefficient | clustercoefficient |double/string|
100-
| closeness | closeness |double/string|
101-
| hanp | hanp | int/string |
102-
| bfs | bfs | string |
103-
| jaccard | jaccard | string |
104-
| node2vec | node2vec | string |
105-
106-
## 版本匹配
84+
## 运算结果写回 NebulaGraph
85+
86+
如果你想将算法结果写入到 NebulaGraph，请确保 NebulaGraph 的 tag 中有对应算法结果名称的属性。各项算法对应的属性名如下所示：
87+
88+
| Algorithm | property name |property type|
89+
|:------------------------:|:-----------------------:|:-----------:|
90+
| pagerank | pagerank |double/string|
91+
| louvain | louvain | int/string |
92+
| kcore | kcore | int/string |
93+
| labelpropagation | lpa | int/string |
94+
| connectedcomponent | cc | int/string |
95+
|stronglyconnectedcomponent| scc | int/string |
96+
| betweenness | betweenness |double/string|
97+
| shortestpath | shortestpath | string |
98+
| degreestatic |degree,inDegree,outDegree| int/string |
99+
| trianglecount | trianglecount | int/string |
100+
| clusteringcoefficient | clustercoefficient |double/string|
101+
| closeness | closeness |double/string|
102+
| hanp | hanp | int/string |
103+
| bfs | bfs | string |
104+
| jaccard | jaccard | string |
105+
| node2vec | node2vec | string |
106+
107+
## 版本兼容矩阵
107108
108109
| Nebula Algorithm Version | Nebula Version |
109110
|:------------------------:|:--------------:|
@@ -113,7 +114,7 @@ nebula-algorithm 是一款基于 [GraphX](https://spark.apache.org/graphx/) 的
113114
| 2.6.0 | 2.6.0, 2.6.1 |
114115
| 2.6.1 | 2.6.0, 2.6.1 |
115116
| 2.6.2 | 2.6.0, 2.6.1 |
116-
| 3.0.0 | 3.0.0 |
117+
| 3.0.0 |3.0.x, 3.1.x, 3,2.x, 3.3.x|
117118
| 3.0-SNAPSHOT | nightly |
118119
119120
## 贡献

‎README.md‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -91,28 +91,30 @@ You could submit the entire spark application or invoke algorithms in `lib` libr
9191
For examples of other algorithms, see [examples](https://github.com/vesoft-inc/nebula-algorithm/tree/master/example/src/main/scala/com/vesoft/nebula/algorithm)
9292
> Note: The first column of DataFrame in the application represents the source vertices, the second represents the target vertices and the third represents edges' weight.
9393
94-
## Nebula config
95-
If you want to write the algorithm result into Nebula, make sure there is corresponding property name in your tag.
96-
| Algorithm | property name |property type|
97-
|:------------------------:|:-----------------------:|:-----------:|
98-
| pagerank | pagerank |double/string|
99-
| louvain | louvain | int/string |
100-
| kcore | kcore | int/string |
101-
| labelpropagation | lpa | int/string |
102-
| connectedcomponent | cc | int/string |
103-
|stronglyconnectedcomponent| scc | int/string |
104-
| betweenness | betweenness |double/string|
105-
| shortestpath | shortestpath | string |
106-
| degreestatic |degree,inDegree,outDegree| int/string |
107-
| trianglecount | trianglecount | int/string |
108-
| clusteringcoefficient | clustercoefficient |double/string|
109-
| closeness | closeness |double/string|
110-
| hanp | hanp | int/string |
111-
| bfs | bfs | string |
112-
| jaccard | jaccard | string |
113-
| node2vec | node2vec | string |
94+
## Sink to NebulaGraph
95+
96+
If you want to write the algorithm execution result into NebulaGraph(`sink: nebula`), make sure there is corresponding property name in your tag defination.
97+
98+
| Algorithm | property name |property type|
99+
|:------------------------:|:-----------------------:|:-----------:|
100+
| pagerank | pagerank |double/string|
101+
| louvain | louvain | int/string |
102+
| kcore | kcore | int/string |
103+
| labelpropagation | lpa | int/string |
104+
| connectedcomponent | cc | int/string |
105+
|stronglyconnectedcomponent| scc | int/string |
106+
| betweenness | betweenness |double/string|
107+
| shortestpath | shortestpath | string |
108+
| degreestatic |degree,inDegree,outDegree| int/string |
109+
| trianglecount | trianglecount | int/string |
110+
| clusteringcoefficient | clustercoefficient |double/string|
111+
| closeness | closeness |double/string|
112+
| hanp | hanp | int/string |
113+
| bfs | bfs | string |
114+
| jaccard | jaccard | string |
115+
| node2vec | node2vec | string |
114116
115-
## Version match
117+
## Version Compatibility Matrix
116118
117119
| Nebula Algorithm Version | Nebula Version |
118120
|:------------------------:|:--------------:|
@@ -122,7 +124,7 @@ You could submit the entire spark application or invoke algorithms in `lib` libr
122124
| 2.6.0 | 2.6.0, 2.6.1 |
123125
| 2.6.1 | 2.6.0, 2.6.1 |
124126
| 2.6.2 | 2.6.0, 2.6.1 |
125-
| 3.0.0 | 3.0.x, 3.1.x |
127+
| 3.0.0 | 3.0.x, 3.1.x, 3.2.x, 3.3.x |
126128
| 3.0-SNAPSHOT | nightly |
127129
128130
## Contribute

0 commit comments

Comments
 (0)