Skip to content

Commit 972d574

Browse files
committed
Update node sim config docs
1 parent f82edb8 commit 972d574

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/modules/ROOT/partials/algorithms/node-similarity/specific-configuration.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ If unspecified, the algorithm runs unweighted.
2121
| similarityMetric
2222
| String | JACCARD | yes | The metric used to compute similarity.
2323
Can be either `JACCARD`, `OVERLAP` or `COSINE`.
24-
| [[runwcc-{instance}]] runWcc | Boolean | false | yes | If enabled, xref:algorithms/wcc.adoc[WCC] is run as a pre-processing step to obtain the graph components.
25-
This can increase performance for multi-component graphs, since nodes in distinct components always have zero similarity and do not need to be compared.
26-
If the components are already stored in a node property, use the `componentProperty` configuration parameter instead.
27-
| [[component-property-{instance}]] componentProperty | String | null | yes | Node property containing the ID of the graph components. If not available, use the `runWcc` configuration parameter instead.
24+
| [[useComponents-{instance}]] useComponents | Boolean or String | false | yes
25+
| If enabled, Node Similarity will use components to improve the performance of the computation, skipping comparisons of nodes in different components.
26+
Set to `false` (Default): the algorithm does not use components, but computes similarity across the entire graph.
27+
Set to `true`: the algorithm uses components, and will compute these components before computing similarity.
28+
Set to *String*: use pre-computed components stored in the graph, with *String* as the key for a node property representing components

0 commit comments

Comments
 (0)