Skip to content

Commit 3fea36a

Browse files
brs96adamnsch
andcommitted
Refactor doc
Co-authored-by: Adam Schill Collberg <adam.schill.collberg@protonmail.com>
1 parent 1bb6e2a commit 3fea36a

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

doc/modules/ROOT/pages/common-datasets.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,3 +285,5 @@ assert G.relationship_count() == 5_088_434
285285
assert len(G.relationship_types()) == 51 * 3
286286
assert G.relationship_properties()["drug-drug_polycystic_ovary_syndrome_TRAIN"] == ["classLabel"]
287287
----
288+
289+
include::ROOT:partial$/graph-construct-limitation.adoc[]

doc/modules/ROOT/pages/graph-object.adoc

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -159,16 +159,7 @@ This in particular means that:
159159
If multiple node dataframes are used, they need to contain distinct node ids across all node data frames.
160160
* Prior to the `construct` call, a call to `GraphDataScience.set_database` must have been made to explicitly specify which Neo4j database should be targeted.
161161

162-
163-
=== Limitations on community edition
164-
165-
For users of GDS community edition, `gds.graph.construct` leverages Cypher Aggregation in implementation.
166-
This implies performance can be impacted for large graphs.
167-
It is possible that socket connection with the database times out.
168-
If this happens, a possible workaround is to modify the server configuration [https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.bolt.connection_keep_alive]`server.bolt.connection_keep_alive`
169-
or [https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.bolt.connection_keep_alive_probes]`server.bolt.connection_keep_alive_probes`.
170-
However, be aware of the side effects such as a genuine connection issue now taking longer to be detected.
171-
162+
include::ROOT:partial$/graph-construct-limitation.adoc[]
172163

173164
[[networkx]]
174165
== Loading a NetworkX graph
@@ -287,6 +278,8 @@ The direction (`DIRECTED` or `UNDIRECTED`) of the relationships in the projected
287278
If the given NetworkX graph is directed, so a (sub)class of either `networkx.DiGraph` or `networkx.MultiDiGraph`, the relationships will be `DIRECTED` in the projection.
288279
Otherwise, they will be `UNDIRECTED`.
289280

281+
include::ROOT:partial$/graph-construct-limitation.adoc[]
282+
290283

291284
== Inspecting a graph object
292285

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
=== Limitations on community edition
2+
3+
For users of GDS community edition, performance can be impacted for large graphs.
4+
It is possible that socket connection with the database times out.
5+
If this happens, a possible workaround is to modify the server configuration https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.bolt.connection_keep_alive[`server.bolt.connection_keep_alive`]
6+
or https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.bolt.connection_keep_alive_probes[`server.bolt.connection_keep_alive_probes`].
7+
However, be aware of the side effects such as a genuine connection issue now taking longer to be detected.

0 commit comments

Comments
 (0)