Added toUndirected proc documentation

Co-Authored-By: Florentin Dörre <florentin.dorre@neotechnology.com>

Author: yuvalr1neo

doc-test-tools/src/main/java/org/neo4j/gds/doc/syntax/SyntaxMode.java

@@ -35,6 +35,7 @@ public enum SyntaxMode {
     STREAM_SINGLE_PROPERTY("include-with-stream-single-property"),
 
     STREAM_MULTIPLE_PROPERTIES("include-with-stream-multiple-properties"),
+    CONVERT_TO_UNDIRECTED("include-with-convert-to-undirected"),
     STREAM_TOPOLOGY("include-with-stream-topology"),
     GRAPH_EXISTS("graph-exists-syntax"),
     MODEL_EXISTS("model-exists-syntax"),

doc-test/src/test/java/org/neo4j/gds/doc/RelationshipOperationsDocTest.java

@@ -19,6 +19,7 @@
  */
 package org.neo4j.gds.doc;
 
+import org.neo4j.gds.beta.undirected.ToUndirectedProc;
 import org.neo4j.gds.catalog.GraphDropRelationshipProc;
 import org.neo4j.gds.catalog.GraphProjectProc;
 import org.neo4j.gds.catalog.GraphStreamRelationshipPropertiesProc;
@@ -43,6 +44,7 @@ protected List<Class<?>> procedures() {
             NodeSimilarityMutateProc.class,
             GraphStreamRelationshipsProc.class,
             GraphStreamRelationshipPropertiesProc.class,
+            ToUndirectedProc.class,
             GraphWriteRelationshipProc.class,
             GraphDropRelationshipProc.class
         );

doc-test/src/test/java/org/neo4j/gds/doc/syntax/GraphCatalogRelationshipOperationsSyntaxTest.java

@@ -29,6 +29,7 @@ protected Iterable<SyntaxModeMeta> syntaxModes() {
             SyntaxModeMeta.of(SyntaxMode.STREAM_SINGLE_PROPERTY),
             SyntaxModeMeta.of(SyntaxMode.STREAM_TOPOLOGY),
             SyntaxModeMeta.of(SyntaxMode.STREAM_MULTIPLE_PROPERTIES),
+            SyntaxModeMeta.of(SyntaxMode.CONVERT_TO_UNDIRECTED),
             SyntaxModeMeta.of(SyntaxMode.WRITE),
             SyntaxModeMeta.of(SyntaxMode.DELETE_RELATIONSHIPS)
         );

doc/modules/ROOT/pages/graph-catalog-relationship-ops.adoc

@@ -165,6 +165,55 @@ a|
 |===
 ======
 
+[.include-with-convert-to-undirected]
+======
+[source, cypher, role=noplay]
+----
+CALL gds.beta.graph.relationships.toUndirected(
+    graphName: String,
+    configuration: Map
+)
+YIELD
+    inputRelationships: Integer,
+    relationshipsWritten: Integer,
+    mutateMillis: Integer,
+    postProcessingMillis: Integer,
+    preProcessingMillis: Integer,
+    computeMillis: Integer,
+    configuration: Map
+----
+
+.Parameters
+[opts="header",cols="1,1,1,7"]
+|===
+| Name                   | Type                       | Optional | Description
+| graphName              | String                     | no       | The name under which the graph is stored in the catalog.
+| configuration          | Map                        | yes      | Additional parameters to configure streamNodeProperties.
+|===
+
+.Configuration
+[opts="header",cols="1,1,1,1,6"]
+|===
+| Name                   | Type                  | Optional | Default | Description
+| relationshipType       | String                | no       | n/a     | The relationship type to make undirected.
+| mutateRelationshipType | String                | no       | n/a     | The relationship type to be added to the graph.
+include::partial$/algorithms/common-configuration/common-configuration-jobid-concurrency-entries.adoc[]
+|===
+
+.Results
+[opts="header",cols="2,1,7"]
+|===
+| Name                   | Type      | Description
+| inputRelationships     | Integer   | The number of relationships that were processed.
+| relationshipsWritten   | Integer   | The number of relationships that were added.
+| preProcessingMillis    | Integer   | Milliseconds for preprocessing the graph.
+| computeMillis          | Integer   | Milliseconds for running the algorithm.
+| postProcessingMillis   | Integer   | Unused.
+| mutateMillis           | Integer   | Milliseconds for adding relationships to the projected graph.
+| configuration          | Map       | The configuration used for running the algorithm.
+|===
+======
+
 [.include-with-write]
 ======
 [source, cypher, role=noplay]
@@ -612,6 +661,33 @@ ORDER BY source ASC, target ASC
 
 NOTE: The properties we want to stream must exist for each specified relationship type.
 
+=== Convert to undirected
+
+Some algorithms such as Triangle Count and Link Prediction expect undirected relationships. The following shows how to convert the relationships of type `LIKES` in the graph from directed to undirected by creating an undirected relationship of new type `INTERACTS`.
+
+[role=query-example]
+--
+.Convert relationships from directed to undirected:
+[source, cypher, role=noplay]
+----
+CALL gds.beta.graph.relationships.toUndirected(
+  'personsAndInstruments',                                          // <1>
+  {relationshipType: 'LIKES', mutateRelationshipType: 'INTERACTS'}  // <2>
+)
+YIELD
+  inputRelationships, relationshipsWritten
+----
+<1> The name of the projected graph.
+<2> A map that includes the relationship type to make undirected and the relationship type to be added to the graph.
+
+.Results
+[opts="header"]
+|===
+| inputRelationships      | relationshipsWritten
+| 19                       | 18
+|===
+--
+
 [[catalog-graph-write-relationship-example]]
 === Write
 

doc/modules/ROOT/partials/algorithms/common-configuration/common-configuration-entries.adoc

@@ -1,4 +1,3 @@
 | xref:common-usage/running-algos.adoc#common-configuration-node-labels[nodeLabels]               | List of String | ['*']   | yes      | Filter the named graph using the given node labels.
 | xref:common-usage/running-algos.adoc#common-configuration-relationship-types[relationshipTypes] | List of String | ['*']   | yes      | Filter the named graph using the given relationship types.
-| xref:common-usage/running-algos.adoc#common-configuration-concurrency[concurrency]              | Integer  | 4       | yes      | The number of concurrent threads used for running the algorithm.
-| xref:common-usage/running-algos.adoc#common-configuration-jobid[jobId]                         | String   | Generated internally | yes      | An ID that can be provided to more easily track the algorithm's progress.
+include::partial$/algorithms/common-configuration/common-configuration-jobid-concurrency-entries.adoc[]

doc/modules/ROOT/partials/algorithms/common-configuration/common-configuration-jobid-concurrency-entries.adoc

@@ -0,0 +1,2 @@
+| xref:common-usage/running-algos.adoc#common-configuration-concurrency[concurrency]              | Integer  | 4       | yes      | The number of concurrent threads used for running the algorithm.
+| xref:common-usage/running-algos.adoc#common-configuration-jobid[jobId]                         | String   | Generated internally | yes      | An ID that can be provided to more easily track the algorithm's progress.