Skip to content

Commit a1567c0

Browse files
committed
Add doc and changelog
1 parent 658617f commit a1567c0

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* `gds.graph.ogbl.load` for link property prediction datasets.
1414
* Added possibility to load NetworkX graphs via the new method `gds.graph.networkx.load`.
1515
* Added new sphinx API reference documentation for all procedures.
16+
* Promoted `gds.alpha.graph.construct` to `gds.graph.construct`.
1617

1718
## Bug fixes
1819

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,9 @@ In addition to those aforementioned there are five more methods that create grap
7878
Their Cypher signatures map to Python in much the same way as `gds.graph.project` above.
7979

8080

81-
[.alpha]
8281
[[construct]]
8382
== Constructing a graph from DataFrames
8483

85-
include::ROOT:partial$/alpha-note.adoc[]
86-
8784
Instead of projecting a graph from the Neo4j database it is also possible to construct new graphs using pandas `DataFrames` from the client.
8885

8986
=== Syntax
@@ -163,6 +160,16 @@ If multiple node dataframes are used, they need to contain distinct node ids acr
163160
* Prior to the `construct` call, a call to `GraphDataScience.set_database` must have been made to explicitly specify which Neo4j database should be targeted.
164161

165162

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+
172+
166173
[[networkx]]
167174
== Loading a NetworkX graph
168175

0 commit comments

Comments
 (0)