Releases: neo4j/graph-data-science
Graph Data Science 2.4.0 PREVIEW
Neo4j Graph Data Science version 2.4.0 is compatible with Neo4j version 4.4 and Neo4j versions 5.1 through 5.8.
Breaking changes
- Pass
concurreny
when training a pipeline to the node property steps. Before they were executed with the default concurrency of4
if not overridden. This affectsgds.beta.pipeline.linkPrediction.train
gds.beta.pipeline.nodeClassification.train
gds.alpha.pipeline.nodeClassification.train
New features
- You can rename node properties when writing them back to the neo4j database using
gds.nodeProperties.write
by placing them inside a map in the formnodeProperty: 'renamedProperty'
. - Added
minCommunitySize|minComponentSize
parameter to more procedures to allow filtering the result. (Contributed by @airtyon) This includes:gds.wcc.stream
gds.louvain.stream
gds.labelPropagation.stream
gds.beta.k1coloring.[stream|write]
gds.beta.leiden.[stream|write]
gds.beta.modularityOptimization.[stream|write]
gds.alpha.maxkcut.stream
- Added new procedure
gds.alpha.drop.cypherdb
to drop created in-memory databases - Added Bellman-Ford algorithm:
gds.bellmanFord.stream
gds.bellmanFord.stream.estimate
gds.bellmanFord.stats
gds.bellmanFord.stats.estimate
gds.bellmanFord.mutate
gds.bellmanFord.mutate.estimate
gds.bellmanFord.write
gds.bellmanFord.write.estimate
- Add Random Forest and MLP classifier serialization support. This makes all node classification and link prediction models serializable. This affects
gds.alpha.model.store
andgds.alpha.model.load
. - Added
upperDegreeCutoff
parameter to Node-Similarity and filtered Node-Similarity algorithm which allows skipping nodes if their degree is higher than the provided value. - Added
aggregation
togds.beta.toUndirected
to allow the aggregation of the new undirected relationships. - Added new optional parameter
storeModelToDisk
that automatically saves serializable models after training for licensed users. This affectsgds.beta.pipeline.[linkPrediction|nodeClassification].train
andgds.beta.graphSage.train
. - Added K-Core Decomposition algorithm:
gds.kcore.stats
gds.kcore.stats.estimate
gds.kcore.stream
gds.kcore.stream.estimate
gds.kcore.mutate
gds.kcore.mutate.estimate
gds.kcore.write
gds.kcore.write.estimate
- Added procedure
gds.graph.relationshipProperties.write
that allows writing relationships with multiple properties to Neo4j. - Added new Common Neighbour Aware Random Walk graph sampling algorithm
gds.graph.sample.cnarw
. Available underbeta
tier. - Cypher Aggregation has graduated, which comes with a new name and API changes:
- The method of projection is now generally called "Cypher projection", possible with an additional "new" or "v2" qualifier.
- The existing 'Cypher projection' (
gds.graph.project.cypher
) is now called "Legacy Cypher projection"
- The existing 'Cypher projection' (
- The procedure name is losing the
alpha
qualifier and is now calledgds.graph.project
. - The old name
gds.alpha.graph.project
is deprecated and usages will forward to the new name while also adapting to the new API. - The 4th and 5th parameters
nodeConfig
andrelationshipConfig
have been merged into a singledataConfig
parameter. - The
properties
configuration key in this mergeddataConfig
parameter has been renamed torelationshipProperties
. - The overall projection configuration (e.g.
readConcurrency
) has moved from the 6th parameter to the 5th parameter.
- The method of projection is now generally called "Cypher projection", possible with an additional "new" or "v2" qualifier.
Bug fixes
- Fixed: Arrow server doesn't enable to project graphs with blank names anymore
- Fixed: Arrow validates dangling relationships when creating an in-memory graph.
Improvements
- Improve progress tracking for
gds.beta.graphSage.train
. This will enable progress bars on the python client. - Improve error message for invalid
nodeLabels
andrelationshipTypes
for procedures supporting memory estimation. - Allow running
gds.debug.sysInfo
andgds.debug.arrow
to run against the system database. - Improve automatic conversion of array property values during graph projection.
- The Yens algorithm can now be run in parallel.
- The node regression now verifies upfront that the all
targetProperty
values provided are valid when callinggds.alpha.pipeline.nodeRegression.train
. - The scale properties algorithm has been promoted:
- Added new procedures
gds.scaleProperties.[stream,mutate]
which replacegds.alpha.scaleProperties.[stream,mutate]
that are now deprecated- The scalers
L1Norm
andL2Norm
are not supported in the new procedures.
- The scalers
- Added new procedures
gds.scaleProperties.[stats,write]
to return statistics from a scale properties computation and write scaled properties back to a database respectively - Procedures
gds.scaleProperties.[mutate,stats,stream,write]
support progress tracking with volumes. This will enable progress bars on the python client - Procedures
gds.scaleProperties.[mutate,stats,write]
return statistics from the performed scale computation - Added new parameter
offset
to thelog
scaler. This also affects procedures:gds.pageRank
gds.eigenvector
gds.articleRank
- Added new procedures
gds.scaleProperties.[mutate|stats|stream|write].estimate
for estimating the memory requirements of running the scale properties algorithm - Nodes with missing properties (
null
orNaN
) are now omitted in the scale computation. Their scale value is set toNaN
in the output.
- Added new procedures
- Reduce the memory footprint of the binary embeddings saved by
gds.beta.hashgnn.mutate
. - Promote random forest classifier to beta tier. Added
gds.beta.pipeline.[nodeClassification,linkPrediction].addRandomForest
which replacegds.alpha.pipeline.[nodeClassification,linkPrediction].addRandomForest
that are now deprecated. - Reduced memory allocation for the Spanning Tree algorithm.
- A more effective rerouting algorithm is applied for the minimum Directed Steiner-Tree algorithm when the inverted index is present.
- Improve runtime of
gds.alpha.hits
for concurrency > 1 due to a better partitioning. - Improve parallel runtime of several algorithms due to improvements of our degree-based partitioning. Note this is highly dataset dependent and is not be visible for all datasets. Affected algorithms are:
- FastRP
- HashGNN
- Leiden
- Approxmaxkcut
- Conductance
- LinkPrediction training
- ToUndirected
- Improve parallel runtime of
gds.beta.graph.project.subgraph
when filtering relationships due to a better partitioning. - Improve parallel runtime of
gds.beta.pipeline.linkPrediction.predict
ifsampleRate = 0
due to a better partitioning. - Improve memory usage when projecting very large graphs with very high degree nodes.
- Additional validation for Cypher projection configuration to guide migration and avoid common mistakes.
2.3.4
Graph Data Science 2.3.3
New features
Neo4j Database Compatibility
-
This release is compatible with all Neo4j 5.x database version <=
5.7.0
. Please see our compatibility matrix above. -
Added
includeGraphs
parameter togds.alpha.backup
to allow backups without graphs.
Bug fixes
- Multiclass node classification compatible with non-consecutive class ids
- RandomWalk stable on multiple runs (user contribution by github user hindog)
Improvements
- Make
gds.alpha.restore
more failsafe- Continue to restore graphs and models also after the first failure for a user.
- Improve logging around failures
Full Changelog: 2.3.2...2.3.3
Graph Data Science 2.3.2
GDS 2.3.2 is compatible with Neo4j 5 & 4.4 versions (≥ 4.4.9).
For GDS compatibility with previous releases, please use GDS Compatibility Table.
New features
Neo4j Database Compatibility
- This release is compatible with all Neo4j 5.x database version <=
5.6.0
. Please see our compatibility matrix above.
Bug fixes
- Graphs imported via Arrow no longer cause invalid node mappings that produced
ArrayIndexOutOfBoundsException
s - Correct memory estimation of Leiden for very small graphs
- KNN no longer result in an AIOOB exception if the array node properties did not exist for some nodes
- CELF no longer returns negative gains for some nodes
- GraphSage will no longer return NaN values because of incorrect neighbor sampling
Improvements
- More accurate memory estimation on Node Similarity and filtered Node Similarity algorithms for high topN or topK values.
- The
gds.alpha.modularity
procedures for computing modularity no longer require each community to be smaller than the size of the graph. - Improve the progress logging of
gds.graph.project.cypher
to be more accurate. Especially, this avoids underestimating when the relationship query is more complex.
Graph Data Science 2.3.1
GDS 2.3.1 is compatible with Neo4j 5 & 4.4 versions (≥ 4.4.9) & 4.3 versions (≥ 4.3.15) Database.
For GDS compatibility with previous releases, please use GDS Compatibility Table.
New features
Neo4j Database Compatibility
- This release is compatible with all Neo4j 5.x database version <=
5.5.0
. Please see our compatibility matrix above.
Log Progress
- New optional configuration parameter
logProgress
allows you to specify whether percentage logging for that procedural call is on or off.
Bug fixes
- Louvain no longer reports the incorrect modularity
- Leiden on weighted graphs communities are now reported correctly
- Persisted Models no longer cause false positive error logs when loaded into the Model Catalog
- Yens on graphs without parallel relationships would cause issues
Improvements
- Filtered Node Similarity progress logging has been improved
Graph Data Science 2.3.0
GDS 2.3.0 is compatible with Neo4j 5 & 4.4 versions (≥ 4.4.9) & 4.3 versions (≥ 4.3.15) Database.
For GDS compatibility with previous releases, please use GDS Compatibility Table.
Breaking changes
- Leiden was promoted to the beta tier. It is now called via the 'gds.beta.leiden' command instead of the
gds.alpha.leiden
command. - K-means was promoted to the beta tier. It is now called via the
gds.beta.kmeans
command instead of thegds.alpha.kmeans
command. - Minimum weighted spanning tree algorithm was promoted to the beta tier. It is now called via the
gds.beta.spanningTree
command instead ofgds.alpha.spanningTree
- The procedures
gds.alpha.spanningTree.minimum
andgds.alpha.spanningTree.maximum
have been removed. You can get the same behaviour by specifying the new parameterobjective
ingds.beta.spanningTree
. - The
weightWriteProperty
has been removed as a configuration parameter. To supply the Relationship Type and Property for the produced relationship, use:mutateRelationshipType
mutateProperty
gds.alpha.spanningTree.kmin
andgds.alpha.spanningTree.kmax
have been removed as the K-Spanning Tree algorithm has been moved in its own spacegds.alpha.kSpanningTree
- The parameter
startNodeId
in all Spanning Tree algorithms has been replaced withsourceNode
.
- The procedures
- Arrow: when projecting graphs,
null
will be translated toNaN
for floating point values. This enables users of either the GDS Python Client or PyArrow to loadNaN
properties stored in Pandas DataFrames - Cypher Aggregations will become the primary surface for creating projections with Cypher. Offering a more intuitive and expressive interface than Cypher Projections that can also be used in Fabric or Composite Database setups.
- The algorithm
gds.alpha.influenceMaximization.greedy
has been removed. It's replacement is thegds.beta.influenceMaximization.celf
algorithm which has the same configuration parameters and offers better performance.
New features
Neo4j Database Compatibility
- This release is compatible with all Neo4j 5.x database version <=
5.4.0
. Please see compatibility matrix above.
Minimum Directed Steiner Tree
- Added heuristic for minimum directed Steiner Tree under the
gds.beta.steinerTree
domain.- Added
stats
mode withgds.beta.steinerTree.stats
- Added
stream
mode withgds.beta.steinerTree.stream
- Added
mutate
mode withgds.beta.steinerTree.mutate
- Added
write
mode withgds.beta.steinerTree.write
- Now available in progress tracking -
gds.list.progress()
- Added
Leiden
- New parameter
consecutiveIds
that assigns consecutive ids for the discovered communities. - New parameter
seedProperty
to seed initial communities for nodes. - New parameter
tolerance
to enable convergence criteria based on differences in modularity from one iteration to another. - Now available in progress tracking -
gds.list.progress()
- Added memory estimation mode:
gds.beta.leiden.mutate.estimate
gds.beta.leiden.stats.estimate
gds.beta.leiden.stream.estimate
gds.beta.leiden.write.estimate
Logistic Regression & MLP
- New configuration parameters
classWeights
andfocusWeight
for training methods, supported by procedures:gds.beta.pipeline.nodeClassification.addLogisticRegression
gds.beta.pipeline.nodeClassification.addMLP
gds.beta.pipeline.linkPrediction.addLogisticRegression
gds.beta.pipeline.linkPrediction.addMLP
HashGNN
- New algorithm
gds.alpha.hashgnn.{mutate,stream}
to create HashGNN node embeddings - New estimation procedures
gds.alpha.hashgnn.{mutate,stream}.estimate
to estimate the memory required to run HashGNN
Link Prediction
- Added new optional configuration parameter
negativeRelationshipType
togds.beta.pipeline.linkPrediction.configureSplit
Spanning Tree
- New modes supported:
gds.beta.spanningTree.{stats, stream, mutate}
- New yield outputs for
gds.beta.spanningTree
:- the sum of weights in the discovered spanning tree.
- the number of relationships written or added for write and mutate mode respectively.
- Added memory estimation mode :
gds.beta.spanningTree.stream.estimate
gds.beta.spanningTree.mutate.estimate
gds.beta.spanningTree.stats.estimate
gds.beta.spanningTree.write.estimate
Write Labels
gds.alpha.graph.nodeLabel.mutate
allows for the Graph Projection to be mutated with new labelsgds.alpha.graph.nodeLabel.write
allows for Node Labels to be written back from projections to a Neo4j Database
Graph Projections
- Arrow now supports specifying undirected relationship types using the
undirected_relationship_types
configuration argument - Cypher Aggregations (
gds.alpha.graph.project
) now support specifying undirected relationship types using theundirectedRelationshipTypes
configuration option - New procedure to turn directed relationships into undirected relationships:
gds.beta.graph.relationships.toUndirected
- Projections created using either the Native, Arrow and Cypher Aggregation APIs can now be "inverse indexed", this will enable more efficient algorithm implementations
Administration
- Added the
jobId
andusername
to theongoingGdsProcedures
return field ofgds.alpha.systemMonitor
. - Added username as a new return field to
gds.beta.listProgress
. - Added a new return field to
gds.graph.list
calledschemaWithOrientation
which also includes the orientation. - Administrators can now see all running tasks from all users with
gds.beta.listProgress
Bug fixes
- Minimum Weighted Spanning Tree: Graphs with parallel edges could make the discovered tree have wrong weights on relationships
- Cypher Aggregations: When using
gds.alpha.graph.project
:- The projected graph would list relationship types with zero relationships
- AIOOB exceptions could surface due to sizing errors
- Arrow:
CREATE_DATABASE
action would throw anNullPointerException
if missing ID fields in the Arrow record. A more descriptive exception is provided gds.graph.list
could cause issues on some JDKs when calculating the memory usage of Projections- Export relationship progress logging (
gds.beta.graph.export.csv
) reports the correct progress - Graph constructed with Cypher Aggregation using arbitrary IDs are now blocked from write procedures
- The k-Spanning Tree algorithm no longer returns disconnected partitions
- Multi-threading bug when creating projections via Cypher Aggregation or Arrow could lead to lost labels
- Node label filtering could lead to streamed node properties being null when filters are applied
- Cypher projections and Cypher aggregation would throw the wrong error message when loading an invalid relationship
- Node label filtering that would lead to the wrong results. This also affected: gds.beta.graphSage and gds.beta.graph.relationships.stream
Improvements
Arrow
- graph import now fully supports external node ids in the 64 Bit space.
- graph import now supports 16, 32 or 64 Bit node identifiers.
- Arrow server will now check user RBAC permissions for creating and accessing databases
- Database import now creates a Relationship Type index
Leiden
- Better parallelization and improved overall performance improvements
WCC
- Now supports a new and faster sampling strategy ( undirected and directed graphs) by using the new
inverse index
.
Machine Learning
- Inner components of
pipeline
field returned bygds.pipeline.{ linkPrediction | nodeClassification | nodeRegression }.train
procedures are now present directly as part ofmodelInfo
. Thepipeline
field is now deprecated for removal in a future version.
Other Improvements
- Speed improvements for Dijkstra, Astar, Yens, CELF, weighted Betweenness Centrality, and the Spanning Tree algorithms. The improvements will see a slight increase in the memory consumption of these algorithms.
- Improved error message for invalid node labels and relationship types
- Pregel now supports bidirectional computations (allows for messages to be sent along incoming relationships) using the new
inverse index
. - The procedure
gds.graph.export
now creates a Relationship Type index - Extended node property validation to reject projection configuration mappings with the same property keys, but different default values.
Other changes
- Histograms returned such as
degreeDistribution
ingds.graph.list
can have slightly different values for specific percentiles due to changes in floating point operations. - Progress tracking in the Spanning Tree algorithm has been reworked. Progress reporting may differ from earlier versions.
- Mark the yielded field
schema
as deprecated ingds.graph.list
andgds.graph.drop
. In the next major release, theschema
field will use the semantics ofschemaWithOrientation
- In
gds.alpha.model.store
, the positional argumentfailIfUnsupportedType
is renamed tofailIfUnsupported
. Both will be supported until it is promoted to the beta tier. - Progress tracking for Betweenness Centrality has been reworked. Progress reporting may differ from earlier versions.
Pre-release changes
- The Steiner Tree procedures in
gds.beta.SteinerTree
was originally introduced asgds.alpha.SteinerTree
. The update in naming occurred in 2.3.0-alpha04.
Graph Data Science 2.2.7
GDS 2.2.7 is compatible with Neo4j 5 & 4.4 versions (≥ 4.4.9) & 4.3 versions (≥ 4.3.15) Database.
For GDS compatibility with previous releases, please use GDS Compatibility Table.
New features
- Added compatibility for Neo4j database 5.4.0.
Bug fixes
- Missing id fields in the Arrow records for the
CREATE_DATABASE
action would throw aNullPointerException
. It now throws a more descriptive exception instead. - Graphs with long node or relationship property names would fail during the restore process.
- Yens algorithm would ignore edges in multigraphs and yield incorrect results.
- Multi-threading bug when creating projections via Cypher Aggregation or Arrow could lead to lost labels.
- Node label filtering could lead to streamed node properties being null when filters are applied.
- Cypher projections and Cypher aggregation would throw the wrong error message when loading an invalid relationship.
- Node label filtering that would lead to the wrong results. This also affected:
gds.beta.graphSage
andgds.beta.graph.relationships.stream
.
Graph Data Science 2.3.0-Alpha04
GDS 2.3.0-alpha04 is compatible with Neo4j 5 & 4.4 versions (≥ 4.4.9) & 4.3 versions (≥ 4.3.15) Database.
For GDS compatibility with previous releases, please use GDS Compatibility Table.
Breaking changes
- Leiden was promoted to the beta tier. It is now called via the 'gds.beta.leiden' command instead of the
gds.alpha.leiden
command. - K-means was promoted to the beta tier. It is now called via the
gds.beta.kmeans
command instead of thegds.alpha.kmeans
command. - Minimum weighted spanning tree algorithm was promoted to the beta tier. It is now called via the
gds.beta.spanningTree
command instead ofgds.alpha.spanningTree
- The procedures
gds.alpha.spanningTree.minimum
andgds.alpha.spanningTree.maximum
have been removed. You can get the same behaviour by specifying the new parameterobjective
ingds.beta.spanningTree
. - The
weightWriteProperty
has been removed as a configuration parameter. To supply the Relationship Type and Property for the produced relationship, use:mutateRelationshipType
mutateProperty
gds.alpha.spanningTree.kmin
andgds.alpha.spanningTree.kmax
have been removed as the K-Spanning Tree algorithm has been moved in its own spacegds.alpha.kSpanningTree
- The parameter
startNodeId
in all Spanning Tree algorithms has been replaced withsourceNode
.
- The procedures
- Arrow: when projecting graphs,
null
will be translated toNaN
for floating point values. This enables users of either the GDS Python Client or PyArrow to loadNaN
properties stored in Pandas DataFrames - Cypher Aggregations will become the primary surface for creating projections with Cypher. Offering a more intuitive and expressive interface than Cypher Projections that can also be used in Fabric or Composite Database setups.
- The algorithm
gds.alpha.influenceMaximization.greedy
has been removed. It's replacement is the already existinggds.beta.influenceMaximization.celf
algorithm which has the same configuration parameters and offers better performance.
New features
Minimum Directed Steiner Tree
- Added heuristic for minimum directed Steiner Tree under the
gds.beta.steinerTree
domain.- Added
stats
mode withgds.beta.steinerTree.stats
- Added
stream
mode withgds.beta.steinerTree.stream
- Added
mutate
mode withgds.beta.steinerTree.mutate
- Added
write
mode withgds.beta.steinerTree.write
- Now available in progress tracking -
gds.list.progress()
- Added
Leiden
- New parameter
consecutiveIds
that assigns consecutive ids for the discovered communities. - New parameter
seedProperty
to seed initial communities for nodes. - New parameter
tolerance
to enable convergence criteria based on difference in modularity from one iteration to another. - Now available in progress tracking -
gds.list.progress()
- Added memory estimation mode:
gds.beta.leiden.mutate.estimate
gds.beta.leiden.stats.estimate
gds.beta.leiden.stream.estimate
gds.beta.leiden.write.estimate
Logistic Regression & MLP
- New configuration parameters
classWeights
andfocusWeight
for training methods, supported by procedures:gds.beta.pipeline.nodeClassification.addLogisticRegression
gds.beta.pipeline.nodeClassification.addMLP
gds.beta.pipeline.linkPrediction.addLogisticRegression
gds.beta.pipeline.linkPrediction.addMLP
HashGNN
- New algorithm
gds.alpha.hashgnn.{mutate,stream}
to create HashGNN node embeddings - New procedures
gds.alpha.hashgnn.{mutate,stream}.estimate
to estimate the memory required to run HashGNN
Link Prediction
- Added new optional configuration parameter
negativeRelationshipType
togds.beta.pipeline.linkPrediction.configureSplit
Spanning Tree
- New modes supported:
gds.beta.spanningTree.(stats, stream, mutate)
- New yield output for
gds.beta.spanningTree
that outputs the sum of weights in the discovered spanning tree. - New yield output for
gds.beta.spanningTree
that outputs the number of relationships written or added for write and mutate mode respectively. - Added memory estimation mode :
gds.beta.spanningTree.stream.estimate
gds.beta.spanningTree.mutate.estimate
gds.beta.spanningTree.stats.estimate
gds.beta.spanningTree.write.estimate
Write Labels
- Added
gds.alpha.graph.nodeLabel.write
to allow for Node Labels to be written back from projections to a Neo4j Database
Graph Projections
- Arrow now supports specifying undirected relationship types using the
undirected_relationship_types
configuration argument - Cypher Aggregations (
gds.alpha.graph.project
) now support specifying undirected relationship types using theundirectedRelationshipTypes
configuration option - New procedure to turn directed relationships into undirected relationships:
gds.beta.graph.relationships.toUndirect
Administration
- Added the
jobId
andusername
to theongoingGdsProcedures
return field ofgds.alpha.systemMonitor
. - Added username as a new return field to
gds.beta.listProgress
. - Added a new return field to
gds.graph.list
calledschemaWithOrientation
which also includes the orientation. - Administrators can now see all running tasks from all users with
gds.beta.listProgress
Bug fixes
- Minimum Weighted Spanning Tree: Graphs with parallel edges could make the discovered tree have wrong weights on relationships
- Cypher Aggregations: When using
gds.alpha.graph.project
:- The projected graph would list relationship types with zero relationships
- AIOOB exceptions could surface due to sizing errors
- Arrow:
CREATE_DATABASE
action would throw a NPE if missing id fields in Arrow record.. A more descriptive exception is provided
Improvements
Arrow
- graph import now fully supports external node ids in the 64 Bit space.
- graph import now supports 16, 32 or 64 Bit node identifiers.
Leiden
- Better parallelization and improved overall performance improvements
Other Improvements
- Speed improvements for Dijkstra, Astar, Yens, CELF, weighted Betweenness Centrality, and the Spanning Tree algorithms. The improvements will see a slight increase in the memory consumption of these algorithms.
- Improved error message for invalid node labels and relationship types
Other changes
- Histograms returned such as
degreeDistribution
ingds.graph.list
can have slightly different values for specific percentiles due to changes in floating point operations. - Progress tracking in the Spanning Tree algorithm has been reworked. Progress reporting may differ from earlier versions.
- Mark the yielded field
schema
as deprecated ingds.graph.list
andgds.graph.drop
. In the next major release, theschema
field will use the semantics ofschemaWithOrientation
- In
gds.alpha.model.store
, the positional argument failIfUnsupportedType is renamed to failIfUnsupported. Both will be supported until it is promoted to the beta tier. - Progress tracking for Betweenness Centrality has been reworked. Progress reporting may differ from earlier versions.
Graph Data Science 2.2.6
Neo4j Graph Data Science 2.2.6 is compatible with Neo4j Database 5 versions & 4.4 versions ≥ 4.4.9 & 4.3 versions ≥ 4.3.15.
For Neo4j Graph Data Science compatibility, please use the Neo4j Compatibility Matrix.
Improvements
- Added support for Neo4j Database 5.3
Graph Data Science 2.3.0-alpha03
GDS 2.3.0-alpha03 is compatible with Neo4j 5 versions & 4.4 versions ≥ 4.4.9 & 4.3 versions ≥ 4.3.15.
For GDS compatibility with previous releases, please use GDS Compatibility Table.
Breaking changes
- Leiden promoted to the beta tier. It is now called via the 'gds.beta.leiden' command instead of the
gds.alpha.leiden
command. - K-means is promoted to the beta tier. It is now called via the
gds.beta.kmeans
command instead of thegds.alpha.kmeans
command. - The parameter
startNodeId
in Spanning Tree algorithms have been replaced withsourceNode
. - The minimum weighted spanning tree algorithm is moved to beta. It is now called via the
gds.beta.spanningTree
command instead ofgds.alpha.spanningTree
- The procedures
gds.alpha.spanningTree.minimum
andgds.alpha.spanningTree.maximum
have been removed. You can get the same behavior by specifying the new parameterobjective
ingds.beta.spanningTree
.
- The procedures
New features
Minimum Directed Steiner Tree
- Added heuristic for minimum directed Steiner Tree under the
gds.alpha.steinerTree
domain.- Added
stats
mode withgds.alpha.steinerTree.stats
- Added
stream
mode withgds.alpha.steinerTree.stream
- Added
mutate
mode withgds.alpha.steinerTree.mutate
- Added
write
mode withgds.alpha.steinerTree.write
- Added
Leiden
- New parameter
consecutiveIds
that assigns consecutive ids for the discovered communities. - New parameter
seedProperty
to seed initial communities for nodes. - New parameter
tolerance
to enable convergence criteria based on difference in modularity from one iteration to another. - Now available in progress tracking -
gds.list.progress()
- Added memory estimation mode:
gds.beta.leiden.mutate.estimate
gds.beta.leiden.stats.estimate
gds.beta.leiden.stream.estimate
gds.beta.leiden.write.estimate
Logistic Regression & MLP
- New configuration parameters
classWeights
andfocusWeight
for training methods, supported by procedures:gds.beta.pipeline.nodeClassification.addLogisticRegression
gds.beta.pipeline.nodeClassification.addMLP
gds.beta.pipeline.linkPrediction.addLogisticRegression
gds.beta.pipeline.linkPrediction.addMLP
HashGNN
- New algorithm
gds.alpha.hashgnn.{mutate,stream}
to create HashGNN node embeddings - New procedures
gds.alpha.hashgnn.{mutate,stream}.estimate
to estimate the memory required to run HashGNN
Link Prediction
- Added new optional configuration parameter
negativeRelationshipType
togds.beta.pipeline.linkPrediction.configureSplit
Spanning Tree
- New modes supported:
gds.alpha.spanningTree.(stats, stream, mutate)
- New yield output for
gds.alpha.spanningTree
that outputs the sum of weights in the discovered spanning tree. - New yield output for
gds.alpha.spanningTree
that outputs the number of relationships written or added for write and mutate mode respectively. - Added memory estimation mode :
gds.alpha.spanningTree.stream.estimate
gds.alpha.spanningTree.mutate.estimate
gds.alpha.spanningTree.stats.estimate
gds.alpha.spanningTree.write.estimate
Write Labels
- Added
gds.alpha.graph.nodeLabel.write
to allow for Node Labels to be written back from projections to a Neo4j Database
Administration
- Added the
jobId
andusername
to theongoingGdsProcedures
return field ofgds.alpha.systemMonitor
. - Added username as a new return field to
gds.beta.listProgress
. - Added a new return field to
gds.graph.list
calledschemaWithOrientation
which also includes the orientation.
Bug fixes
- Fixed a bug in Minimum Weighted Spanning Tree on graphs with parallel edges where the discovered tree could have wrong weights.
Improvements
Arrow
- graph import now fully supports external node ids in the 64 Bit space.
- graph import now supports 16, 32 or 64 Bit node identifiers.
Leiden
- Better parallelization and improved overall performance improvements
Other Algorithms
- Speed improvements for Dijkstra, Astar, Yens, CELF, weighted Betweenness Centrality, and the Spanning Tree algorithms. The improvements will see a slight increase in the memory consumption of these algorithms.
Other changes
- Histograms returned such as
degreeDistribution
ingds.graph.list
can have slightly different values for specific percentiles due to changes in floating point operations. - Progress tracking in the Spanning Tree algorithm has been reworked. Progress reporting may differ from earlier versions.
- Mark the yielded field
schema
as deprecated ingds.graph.list
andgds.graph.drop
. In the next major release, theschema
field will use the semantics ofschemaWithOrientation