Skip to content

Commit ace3144

Browse files
vnickolovdavidoliverSP2
vnickolov
and
davidoliverSP2
committed
Apply code formatting to the Configuration and Results tables
Co-authored-by: David Oliver <[email protected]>
1 parent 5bbf16f commit ace3144

File tree

7 files changed

+201
-201
lines changed

7 files changed

+201
-201
lines changed

‎doc/asciidoc/migration-algos-common.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ This section describes changes between Graph Algorithms library and Graph Data
1414
[opts=header,cols="1,1,1"]
1515
|===
1616
|Graph Algorithms v3.5 |Graph Data Science v1.0 Named Graph |Graph Data Science v1.0 Anonymous Graph
17-
| - | graphName | graphConfiguration
17+
| - | `graphName` | `graphConfiguration`
1818
| node label footnote:common-node-inlined[Moved to `graphConfiguration` as `nodeProjection`] | - | -
1919
| relationship type footnote:common-rel-inlined[Moved to `graphConfiguration` as `relationshipProjection`] | - | -
20-
| direction | - | -
21-
| config | configuration | -
20+
| `direction` | - | -
21+
| `config` | `configuration` | -
2222
|===
2323

2424
.Changes in configuration parameter map
@@ -27,12 +27,12 @@ This section describes changes between Graph Algorithms library and Graph Data
2727
|Graph Algorithms v3.5 |Graph Data Science v1.0
2828
|`write: true` | Replaced by dedicated `write` mode
2929
|`graph: 'cypher'\|'huge'` | Removed. Always using `huge` graph footnote:graph-param[Graph creation with cypher queries has dedicate `gds.graph.create.cypher` procedure. There are parameters `nodeQuery` and `relationshipQuery` for anonymous graphs]
30-
|direction | Replaced by `projection` parameter of `relationshipProjection`
30+
|`direction` | Replaced by `projection` parameter of `relationshipProjection`
3131
|`direction: 'OUTGOING'` | `orientation: 'NATURAL'`
3232
|`direction: 'INCOMING'` | `orientation: 'REVERSE'`
3333
|`direction: 'BOTH'` | Removed footnote:direction-both[This behaviour can be achieved by creating two relationship projections - one with `orientation: 'NATURAL'` and one with `orientation: 'REVERSE'`. See <<direction-both-example, this example>>]
3434
|`undirected: true` | Replaced by `orientation: 'UNDIRECTED'` parameter of `relationshipProjection`
35-
|duplicateRelationships | Replaced by `aggregation` parameter of `relationshipProjection`
35+
|`duplicateRelationships` | Replaced by `aggregation` parameter of `relationshipProjection`
3636
|`duplicateRelationships: 'SKIP'` | `aggregation: 'SINGLE'`
3737
|`iterations` | `maxIterations`
3838
|===

‎doc/asciidoc/migration-graph-ops.adoc

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@
1616
[opts=header,cols="1,1"]
1717
|===
1818
|Graph Algorithms v3.5 |Graph Data Science v1.0
19-
| requiredMemory | requiredMemory
20-
| bytesMin | bytesMin
21-
| bytesMax | bytesMax
22-
| mapView | mapView
23-
| - | treeView
24-
| - | nodeCount
25-
| - | relationshipCount
19+
| `requiredMemory` | `requiredMemory`
20+
| `bytesMin` | `bytesMin`
21+
| `bytesMax` | `bytesMax`
22+
| `mapView` | `mapView`
23+
| - | `treeView`
24+
| - | `nodeCount`
25+
| - | `relationshipCount`
2626
|===
2727

2828
The most significant change in memory estimation is that in GDS to estimate an operation you suffix it with `.estimate` while in GA the operation had to be passed as parameter to `algo.memrec`.
@@ -81,21 +81,21 @@ CALL gds.graph.create.cypher.estimate(
8181
[opts=header, cols="1,1"]
8282
|====
8383
|Graph Algorithms v3.5 |Graph Data Science v1.0
84-
| name | graphName
85-
| graph | -
86-
| direction | -
87-
| undirected | -
88-
| sorted | -
89-
| nodes | nodesCount
90-
| loadMillis | createMillis
91-
| alreadyLoaded | -
92-
| nodeProperties | -
93-
| relationshipProperties | relationshipCount
94-
| relationshipWeight | -
95-
| loadNodes | -
96-
| loadRelationships | -
97-
| - | nodeProjection
98-
| - | relationshipProjection
84+
| `name` | `graphName`
85+
| `graph` | -
86+
| `direction` | -
87+
| `undirected` | -
88+
| `sorted` | -
89+
| `nodes` | `nodesCount`
90+
| `loadMillis` | `createMillis`
91+
| `alreadyLoaded` | -
92+
| `nodeProperties` | -
93+
| `relationshipProperties` | `relationshipCount`
94+
| `relationshipWeight` | -
95+
| `loadNodes` | -
96+
| `loadRelationships` | -
97+
| - | `nodeProjection`
98+
| - | `relationshipProjection`
9999
|====
100100
.Loading a named graph in the default way:
101101
[opts=header,cols="1a,1a"]
@@ -290,16 +290,16 @@ CALL gds.graph.create.cypher(
290290
[opts=header,cols="1,1"]
291291
|===
292292
|Graph Algorithms v3.5 |Graph Data Science v1.0
293-
| name | graphName
294-
| nodes | nodeCount
295-
| relationships | relationshipCount
296-
| type | -
297-
| direction | -
298-
| - | nodeProjection
299-
| - | relationshipProjection
300-
| - | nodeQuery footnote:list-cypher[Field will be `null` unless a Cypher projection was used]
301-
| - | relationshipQuery footnote:list-cypher[]
302-
| - | degreeDistribution footnote:[Graph statistics map, i.e. min, max, percentiles, etc.]
293+
| `name` | `graphName`
294+
| `nodes` | `nodeCount`
295+
| `relationships` | `relationshipCount`
296+
| `type` | -
297+
| `direction` | -
298+
| - | `nodeProjection`
299+
| - | `relationshipProjection`
300+
| - | `nodeQuery` footnote:list-cypher[Field will be `null` unless a Cypher projection was used]
301+
| - | `relationshipQuery` footnote:list-cypher[]
302+
| - | `degreeDistribution` footnote:[Graph statistics map, i.e. min, max, percentiles, etc.]
303303
|===
304304

305305
.Listing named graphs:
@@ -325,19 +325,19 @@ CALL gds.graph.list()
325325
[opts=header,cols="1,1"]
326326
|===
327327
|Graph Algorithms v3.5 |Graph Data Science v1.0
328-
| name | graphName
329-
| nodes | nodeCount
330-
| relationships | relationshipCount
331-
| exists | -
332-
| removed | -
333-
| type | -
334-
| direction | -
335-
| - | nodeProjection
336-
| - | relationshipProjection
337-
| - | nodeQuery footnote:info-cypher[Field will be `null` unless a Cypher projection was used]
338-
| - | relationshipQuery footnote:info-cypher[]
339-
| - | degreeDistribution footnote:[Graph statistics map, i.e. min, max, percentiles, etc.]
340-
| min, max, mean, p50, p75, p90, p95, p99, p999 footnote:info-degreeDistribution[Inlined into `degreeDistribution`] | -
328+
| `name` | `graphName`
329+
| `nodes` | `nodeCount`
330+
| `relationships` | `relationshipCount`
331+
| `exists` | -
332+
| `removed` | -
333+
| `type` | -
334+
| `direction` | -
335+
| - | `nodeProjection`
336+
| - | `relationshipProjection`
337+
| - | `nodeQuery` footnote:info-cypher[Field will be `null` unless a Cypher projection was used]
338+
| - | `relationshipQuery` footnote:info-cypher[]
339+
| - | `degreeDistribution` footnote:[Graph statistics map, i.e. min, max, percentiles, etc.]
340+
| `min, max, mean, p50, p75, p90, p95, p99, p999` footnote:info-degreeDistribution[Inlined into `degreeDistribution`] | -
341341
|===
342342

343343
.Viewing information about a specific named graph:
@@ -389,18 +389,18 @@ RETURN dd.min, dd.max, dd.mean, dd.p50
389389
[opts=header,cols="1,1"]
390390
|===
391391
|Graph Algorithms v3.5 |Graph Data Science v1.0
392-
| name | graphName
393-
| nodes | nodeCount
394-
| relationships | relationshipCount
395-
| exists | -
396-
| removed | -
397-
| type | -
398-
| direction | -
399-
| - | nodeProjection
400-
| - | relationshipProjection
401-
| - | nodeQuery footnote:remove-cypher[Field will be `null` unless a Cypher projection was used]
402-
| - | relationshipQuery footnote:remove-cypher[]
403-
| - | degreeDistribution
392+
| `name` | `graphName`
393+
| `nodes` | `nodeCount`
394+
| `relationships` | `relationshipCount`
395+
| `exists` | -
396+
| `removed` | -
397+
| `type` | -
398+
| `direction` | -
399+
| - | `nodeProjection`
400+
| - | `relationshipProjection`
401+
| - | `nodeQuery` footnote:remove-cypher[Field will be `null` unless a Cypher projection was used]
402+
| - | `relationshipQuery` footnote:remove-cypher[]
403+
| - | `degreeDistribution`
404404
|===
405405

406406
.Removing a named graph:

‎doc/asciidoc/migration-louvain.adoc

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,44 @@
55
[opts=header,cols="1a,1a"]
66
|===
77
|Graph Algorithms v3.5 |Graph Data Science v1.0
8-
| direction | -
9-
| levels | maxLevels
10-
| concurrency | concurrency
11-
| readConcurrency | readConcurrency footnote:louvain-read[Only when using anonymous graph]
12-
| writeConcurrency | writeConcurrency footnote:louvain-write[Only for `write` mode]
13-
| weightProperty | relationshipWeightProperty
14-
| seedProperty | seedProperty
15-
| innerIterations | maxIterations
16-
| includeIntermediateCommunities | includeIntermediateCommunities
17-
| tolerance | tolerance
18-
| writeProperty | writeProperty footnote:louvain-write[]
19-
| write | -
20-
| graph | -
8+
| `direction` | -
9+
| `levels` | `maxLevels`
10+
| `concurrency` | `concurrency`
11+
| `readConcurrency` | `readConcurrency` footnote:louvain-read[Only when using anonymous graph]
12+
| `writeConcurrency` | `writeConcurrency` footnote:louvain-write[Only for `write` mode]
13+
| `weightProperty` | `relationshipWeightProperty`
14+
| `seedProperty` | `seedProperty`
15+
| `innerIterations` | `maxIterations`
16+
| `includeIntermediateCommunities` | `includeIntermediateCommunities`
17+
| `tolerance` | `tolerance`
18+
| `writeProperty` | `writeProperty` footnote:louvain-write[]
19+
| `write` | -
20+
| `graph` | -
2121
|===
2222

2323
.Changes in YIELD fields
2424
[opts=header,cols="1a,1a"]
2525
|===
2626
|Graph Algorithms v3.5 |Graph Data Science v1.0
27-
| loadMillis | createMillis
28-
| computeMillis | computeMillis
29-
| writeMillis | writeMillis
30-
| postProcessingMillis | postProcessingMillis
31-
| nodes | nodePropertiesWritten
32-
| communityCount | communityCount
33-
| levels | ranLevels
34-
| nodeId | nodeId footnote:louvain-yield-stream[Only for `stream` mode]
35-
| community | communityId footnote:louvain-yield-stream[]
36-
| communities | communityIds footnote:louvain-yield-stream[]
37-
| modularity | modularity footnote:louvain-yield-write[Only for `write` mode]
38-
| modularities | modularities footnote:louvain-yield-write[]
39-
| write | -
40-
| - | communityDistribution
41-
| - | configuration footnote:louvain-gds-config[The configuration used to run the algorithm]
42-
| includeIntermediateCommunities footnote:louvain-config[Inlined into `configuration`] | -
43-
| writeProperty footnote:louvain-config[] | -
44-
| weightProperty footnote:louvain-weight-config[Inlined into `configuration` as `relationshipWeightProperty`] | -
45-
| min, max, mean, p50, p75, p90, p95, p99, p999 footnote:louvain-distribution[Inlined into `communityDistribution`] | -
27+
| `loadMillis` | `createMillis`
28+
| `computeMillis` | `computeMillis`
29+
| `writeMillis` | `writeMillis`
30+
| `postProcessingMillis` | `postProcessingMillis`
31+
| `nodes` | `nodePropertiesWritten`
32+
| `communityCount` | `communityCount`
33+
| `levels` | `ranLevels`
34+
| `nodeId` | `nodeId` footnote:louvain-yield-stream[Only for `stream` mode]
35+
| `community` | `communityId` footnote:louvain-yield-stream[]
36+
| `communities` | `communityIds` footnote:louvain-yield-stream[]
37+
| `modularity` | `modularity` footnote:louvain-yield-write[Only for `write` mode]
38+
| `modularities` | `modularities` footnote:louvain-yield-write[]
39+
| `write` | -
40+
| - | `communityDistribution`
41+
| - | `configuration` footnote:louvain-gds-config[The configuration used to run the algorithm]
42+
| `includeIntermediateCommunities` footnote:louvain-config[Inlined into `configuration`] | -
43+
| `writeProperty` footnote:louvain-config[] | -
44+
| `weightProperty` footnote:louvain-weight-config[Inlined into `configuration` as `relationshipWeightProperty`] | -
45+
| `min, max, mean, p50, p75, p90, p95, p99, p999` footnote:louvain-distribution[Inlined into `communityDistribution`] | -
4646
|===
4747

4848
.Louvain Stream Mode

‎doc/asciidoc/migration-lpa.adoc

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,39 @@
55
[opts=header,cols="1a,1a"]
66
|===
77
|Graph Algorithms v3.5 |Graph Data Science v1.0
8-
| direction | -
9-
| iterations | maxIterations
10-
| concurrency | concurrency
11-
| readConcurrency | readConcurrency footnote:lpa-read[Only when using anonymous graph]
12-
| writeConcurrency | writeConcurrency footnote:lpa-write[Only for `write` mode]
13-
| weightProperty footnote:weight-prop[Can be configured separately by using `nodeWeightProperty` and `relationshipWeightProperty`] | -
14-
| - | nodeWeightProperty
15-
| - | relationshipWeightProperty
16-
| seedProperty | seedProperty
17-
| partitionProperty | -
18-
| writeProperty | writeProperty footnote:lpa-write[]
19-
| write | -
20-
| graph | -
8+
| `direction` | -
9+
| `iterations` | `maxIterations`
10+
| `concurrency` | `concurrency`
11+
| `readConcurrency` | `readConcurrency` footnote:lpa-read[Only when using anonymous graph]
12+
| `writeConcurrency` | `writeConcurrency` footnote:lpa-write[Only for `write` mode]
13+
| `weightProperty` footnote:weight-prop[Can be configured separately by using `nodeWeightProperty` and `relationshipWeightProperty`] | -
14+
| - | `nodeWeightProperty`
15+
| - | `relationshipWeightProperty`
16+
| `seedProperty` | `seedProperty`
17+
| `partitionProperty` | -
18+
| `writeProperty` | `writeProperty` footnote:lpa-write[]
19+
| `write` | -
20+
| `graph` | -
2121
|===
2222

2323
.Changes in YIELD fields
2424
[opts=header,cols="1a,1a"]
2525
|===
2626
|Graph Algorithms v3.5 |Graph Data Science v1.0
27-
|loadMillis |createMillis
28-
|computeMillis |computeMillis
29-
|writeMillis |writeMillis
30-
|postProcessingMillis |postProcessingMillis
31-
|nodes |nodePropertiesWritten
32-
|communityCount |communityCount
33-
|didConverge |didConverge
34-
|- |ranIterations
35-
|write |-
36-
|- |communityDistribution
37-
|- |configuration footnote:lpa-gds-config[The configuration used to run the algorithm]
38-
|writeProperty footnote:lpa-write-config[Inlined into `configuration`] |-
39-
|weightProperty footnote:lpa-weight-config[Inlined into `configuration` as `nodeWeightProperty` and/or `relationshipWeightProperty`] |-
40-
| min, max, mean, p50, p75, p90, p95, p99, p999 footnote:lpa-distribution[Inlined into `communityDistribution`] | -
27+
|`loadMillis` |`createMillis`
28+
|`computeMillis` |`computeMillis`
29+
|`writeMillis` |`writeMillis`
30+
|`postProcessingMillis` |`postProcessingMillis`
31+
|`nodes` |`nodePropertiesWritten`
32+
|`communityCount` |`communityCount`
33+
|`didConverge` |`didConverge`
34+
|- |`ranIterations`
35+
|`write` |-
36+
|- |`communityDistribution`
37+
|- |`configuration` footnote:lpa-gds-config[The configuration used to run the algorithm]
38+
|`writeProperty` footnote:lpa-write-config[Inlined into `configuration`] |-
39+
|`weightProperty` footnote:lpa-weight-config[Inlined into `configuration` as `nodeWeightProperty` and/or `relationshipWeightProperty`] |-
40+
| `min, max, mean, p50, p75, p90, p95, p99, p999` footnote:lpa-distribution[Inlined into `communityDistribution`] | -
4141
|===
4242

4343
.Label Propagation Stream Mode

0 commit comments

Comments
 (0)