Skip to content

Commit 6093c85

Browse files
Mats-SXMats-SX
committed
Remove named graph syntax docs for alpha similarities
1 parent 5972740 commit 6093c85

4 files changed

Lines changed: 14 additions & 51 deletions

File tree

‎doc/asciidoc/algorithms/alpha/alpha-similarity-cosine.adoc‎

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,6 @@ For example, to get movie recommendations based on the preferences of users who
5555
[[algorithms-similarity-cosine-syntax]]
5656
== Syntax
5757

58-
.The following will run the algorithm on a graph in the catalog and write back results:
59-
[source, cypher]
60-
----
61-
CALL gds.alpha.similarity.cosine.write(graphName: String, configuration: Map)
62-
YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, mean, stdDev, p25, p50, p75, p90, p95, p99, p999, p100
63-
----
64-
65-
.Parameters
66-
[opts="header",cols="1,1,1,1,4"]
67-
|===
68-
| Name | Type | Default | Optional | Description
69-
| graphName | String | n/a | no | The name of a graph in the catalog.
70-
| configuration | Map | `{}` | yes | Algorithm-specific configuration.
71-
|===
72-
7358
.The following will create an anonymous graph to run the algorithm on and write back results:
7459
[source, cypher]
7560
----
@@ -81,7 +66,7 @@ YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, me
8166
[opts="header",cols="1,1,1,1,4"]
8267
|===
8368
| Name | Type | Default | Optional | Description
84-
| configuration | Map | `{}` | no | Graph creation and algorithm-specific configuration.
69+
| configuration | Map | n/a | no | Algorithm-specific configuration.
8570
|===
8671

8772
.Configuration
@@ -126,21 +111,6 @@ YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, me
126111
| p100 | Float | The 100 percentile of similarities scores computed.
127112
|===
128113

129-
.The following will run the algorithm on a graph in the catalog and stream results:
130-
[source,cypher]
131-
----
132-
CALL gds.alpha.similarity.cosine.stream(graphName: String, configuration: Map)
133-
YIELD item1, item2, count1, count2, intersection, similarity
134-
----
135-
136-
.Parameters
137-
[opts="header",cols="1,1,1,1,4"]
138-
|===
139-
| Name | Type | Default | Optional | Description
140-
| graphName | String | n/a | no | The name of a graph in the catalog.
141-
| configuration | Map | `{}` | yes | Algorithm-specific configuration.
142-
|===
143-
144114
.The following will create an anonymous graph to run the algorithm on and stream results:
145115
[source, cypher]
146116
----
@@ -152,7 +122,7 @@ YIELD item1, item2, count1, count2, intersection, similarity
152122
[opts="header",cols="1,1,1,1,4"]
153123
|===
154124
| Name | Type | Default | Optional | Description
155-
| configuration | Map | `{}` | no | Graph creation and algorithm-specific configuration.
125+
| configuration | Map | n/a | no | Algorithm-specific configuration.
156126
|===
157127

158128
.Configuration

‎doc/asciidoc/algorithms/alpha/alpha-similarity-euclidean.adoc‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -488,16 +488,15 @@ include::../../management-ops/cypher-projection.adoc[tag=similarity-explanation]
488488
.The following will run the algorithm and write back results:
489489
[source, cypher]
490490
----
491-
CALL gds.alpha.similarity.euclidean.write(graphNameOrConfig: String|Map, configuration: Map)
491+
CALL gds.alpha.similarity.euclidean.write(configuration: Map)
492492
YIELD nodes, similarityPair, writeRelationshipType, writeProperty, min, max, mean, stdDev, p25, p50, p75, p90, p95, p99, p999, p100
493493
----
494494

495495
.Parameters
496496
[opts="header",cols="1,1,1,1,4"]
497497
|===
498498
| Name | Type | Default | Optional | Description
499-
| graphNameOrConfig | String or Map | null | no | Either then name of a loaded graph or directly the config.
500-
| configuration | Map | n/a | yes | Additional configuration, if the first parameter was a graph name.
499+
| configuration | Map | n/a | no | Algorithm-specific configuration.
501500
|===
502501

503502
.Configuration
@@ -545,17 +544,15 @@ YIELD nodes, similarityPair, writeRelationshipType, writeProperty, min, max, mea
545544
.The following will run the algorithm and stream results:
546545
[source,cypher]
547546
----
548-
CALL gds.alpha.similarity.euclidean.stream(graphNameOrConfig: String|Map, configuration: Map)
547+
CALL gds.alpha.similarity.euclidean.stream(configuration: Map)
549548
YIELD item1, item2, count1, count2, intersection, similarity
550-
551549
----
552550

553551
.Parameters
554552
[opts="header",cols="1,1,1,1,4"]
555553
|===
556554
| Name | Type | Default | Optional | Description
557-
| graphNameOrConfig | String or Map | null | no | Either then name of a loaded graph or directly the config.
558-
| configuration | Map | n/a | yes | Additional configuration, if the first parameter was a graph name.
555+
| configuration | Map | n/a | no | Algorithm-specific configuration.
559556
|===
560557

561558
.Configuration

‎doc/asciidoc/algorithms/alpha/alpha-similarity-overlap.adoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -296,16 +296,15 @@ We could use this technique to compute the similarity of a subset of items to al
296296
.The following will run the algorithm and write back results:
297297
[source, cypher]
298298
----
299-
CALL gds.alpha.similarity.overlap.write(graphNameOrConfig: String|Map, configuration: Map)
299+
CALL gds.alpha.similarity.overlap.write(configuration: Map)
300300
YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, mean, stdDev, p25, p50, p75, p90, p95, p99, p999, p100
301301
----
302302

303303
.Parameters
304304
[opts="header",cols="1,1,1,1,4"]
305305
|===
306306
| Name | Type | Default | Optional | Description
307-
| graphNameOrConfig | String or Map | null | no | Either then name of a loaded graph or directly the config.
308-
| configuration | Map | n/a | yes | Additional configuration, if the first parameter was a graph name.
307+
| configuration | Map | n/a | no | Algorithm-specific configuration.
309308
|===
310309

311310

@@ -354,16 +353,15 @@ YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, me
354353
.The following will run the algorithm and stream results:
355354
[source,cypher]
356355
----
357-
CALL gds.alpha.similarity.overlap.stream(graphNameOrConfig: String|Map, configuration: Map)
356+
CALL gds.alpha.similarity.overlap.stream(configuration: Map)
358357
YIELD item1, item2, count1, count2, similarity
359358
----
360359

361360
.Parameters
362361
[opts="header",cols="1,1,1,1,4"]
363362
|===
364363
| Name | Type | Default | Optional | Description
365-
| graphNameOrConfig | String or Map | null | no | Either the name of a created graph or directly the config.
366-
| configuration | Map | n/a | yes | Additional configuration, if the first parameter was a graph name.
364+
| configuration | Map | n/a | no | Algorithm-specific configuration.
367365
|===
368366

369367

‎doc/asciidoc/algorithms/alpha/alpha-similarity-pearson.adoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -484,16 +484,15 @@ RETURN nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, m
484484
.The following will run the algorithm and write back results:
485485
[source, cypher]
486486
----
487-
CALL gds.alpha.similarity.pearson.write(graphNameOrConfig: String|Map, configuration: Map)
487+
CALL gds.alpha.similarity.pearson.write(configuration: Map)
488488
YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, mean, stdDev, p25, p50, p75, p90, p95, p99, p999, p100
489489
----
490490

491491
.Parameters
492492
[opts="header",cols="1,1,1,1,4"]
493493
|===
494494
| Name | Type | Default | Optional | Description
495-
| graphNameOrConfig | String or Map | null | no | Either then name of a loaded graph or directly the config.
496-
| configuration | Map | n/a | yes | Additional configuration, if the first parameter was a graph name.
495+
| configuration | Map | n/a | no | Algorithm-specific configuration.
497496
|===
498497

499498
.Configuration
@@ -541,16 +540,15 @@ YIELD nodes, similarityPairs, writeRelationshipType, writeProperty, min, max, me
541540
.The following will run the algorithm and stream results:
542541
[source,cypher]
543542
----
544-
CALL gds.alpha.similarity.pearson.stream(graphNameOrConfig: String|Map, configuration: Map)
543+
CALL gds.alpha.similarity.pearson.stream(configuration: Map)
545544
YIELD item1, item2, count1, count2, intersection, similarity
546545
----
547546

548547
.Parameters
549548
[opts="header",cols="1,1,1,1,4"]
550549
|===
551550
| Name | Type | Default | Optional | Description
552-
| graphNameOrConfig | String or Map | null | no | Either then name of a loaded graph or directly the config.
553-
| configuration | Map | n/a | yes | Additional configuration, if the first parameter was a graph name.
551+
| configuration | Map | n/a | no | Algorithm-specific configuration.
554552
|===
555553

556554
.Configuration

0 commit comments

Comments
 (0)