Appendix A. Procedures and functions reference

This chapter contains a reference of all the procedures and functions in the Neo4j Graph Data Science library.

This chapter contains the following sections:

A.1. Graph Operations

The following table lists all production-quality graph operations in the GDS library:

Operation Procedure

Create Graph

gds.graph.create

gds.graph.create.estimate

gds.graph.create.cypher

gds.graph.create.cypher.estimate

Check if a named graph exists

gds.graph.exists

List graphs

gds.graph.list

Remove node properties from a named graph

gds.graph.removeNodeProperties

Delete relationships from a named graph

gds.graph.deleteRelationships

Remove a named graph from memory

gds.graph.drop

Stream a single node property to the procedure caller

gds.graph.streamNodeProperty

Stream node properties to the procedure caller

gds.graph.streamNodeProperties

Stream a single relationship property to the procedure caller

gds.graph.streamRelationshipProperty

Stream relationship properties to the procedure caller

gds.graph.streamRelationshipProperties

Write node properties to Neo4j

gds.graph.writeNodeProperties

Write relationships to Neo4j

gds.graph.writeRelationship

Graph Export

gds.graph.export

A.2. Model Catalog Operations

Operation Procedure

Check if a model exists

gds.beta.model.exists

Remove a model

gds.beta.model.drop

List models

gds.beta.model.list

A.3. Production-quality tier

The following table lists all production-quality procedures in the GDS library:

Algorithm Procedure

Label Propagation

gds.labelPropagation.mutate

gds.labelPropagation.mutate.estimate

gds.labelPropagation.write

gds.labelPropagation.write.estimate

gds.labelPropagation.stream

gds.labelPropagation.stream.estimate

gds.labelPropagation.stats

gds.labelPropagation.stats.estimate

Louvain

gds.louvain.mutate

gds.louvain.mutate.estimate

gds.louvain.write

gds.louvain.write.estimate

gds.louvain.stream

gds.louvain.stream.estimate

gds.louvain.stats

gds.louvain.stats.estimate

Node Similarity

gds.nodeSimilarity.mutate

gds.nodeSimilarity.mutate.estimate

gds.nodeSimilarity.write

gds.nodeSimilarity.write.estimate

gds.nodeSimilarity.stream

gds.nodeSimilarity.stream.estimate

gds.nodeSimilarity.stats

gds.nodeSimilarity.stats.estimate

PageRank

gds.pageRank.mutate

gds.pageRank.mutate.estimate

gds.pageRank.write

gds.pageRank.write.estimate

gds.pageRank.stream

gds.pageRank.stream.estimate

gds.pageRank.stats

gds.pageRank.stats.estimate

Weakly Connected Components

gds.wcc.mutate

gds.wcc.mutate.estimate

gds.wcc.write

gds.wcc.write.estimate

gds.wcc.stream

gds.wcc.stream.estimate

gds.wcc.stats

gds.wcc.stats.estimate

Triangle Count

gds.triangleCount.stream

gds.triangleCount.stream.estimate

gds.triangleCount.stats

gds.triangleCount.stats.estimate

gds.triangleCount.write

gds.triangleCount.write.estimate

gds.triangleCount.mutate

gds.triangleCount.mutate.estimate

Local Clustering Coefficient

gds.localClusteringCoefficient.stream

gds.localClusteringCoefficient.stream.estimate

gds.localClusteringCoefficient.stats

gds.localClusteringCoefficient.stats.estimate

gds.localClusteringCoefficient.write

gds.localClusteringCoefficient.write.estimate

gds.localClusteringCoefficient.mutate

gds.localClusteringCoefficient.mutate.estimate

Betweenness Centrality

gds.betweenness.stream

gds.betweenness.stream.estimate

gds.betweenness.stats

gds.betweenness.stats.estimate

gds.betweenness.mutate

gds.betweenness.mutate.estimate

gds.betweenness.write

gds.betweenness.write.estimate

Fast Random Projection

gds.fastRP.mutate

gds.fastRP.mutate.estimate

gds.fastRP.stats

gds.fastRP.stats.estimate

gds.fastRP.stream

gds.fastRP.stream.estimate

gds.fastRP.write

gds.fastRP.write.estimate

A.4. Beta tier

The following table lists all beta graph operations in the GDS library:

Operation Procedure

Generate Random Graph

gds.beta.graph.generate

The following table lists all beta procedures in the GDS library:

Algorithm Procedure

FastRPExtended

gds.beta.fastRPExtended.mutate

gds.beta.fastRPExtended.mutate.estimate

gds.beta.fastRPExtended.stats

gds.beta.fastRPExtended.stats.estimate

gds.beta.fastRPExtended.stream

gds.beta.fastRPExtended.stream.estimate

gds.beta.fastRPExtended.write

gds.beta.fastRPExtended.write.estimate

GraphSAGE

gds.beta.graphSage.stream

gds.beta.graphSage.stream.estimate

gds.beta.graphSage.mutate

gds.beta.graphSage.mutate.estimate

gds.beta.graphSage.write

gds.beta.graphSage.write.estimate

gds.beta.graphSage.train

gds.beta.graphSage.train.estimate

K1Coloring

gds.beta.k1coloring.mutate

gds.beta.k1coloring.mutate.estimate

gds.beta.k1coloring.stats

gds.beta.k1coloring.stats.estimate

gds.beta.k1coloring.stream

gds.beta.k1coloring.stream.estimate

gds.beta.k1coloring.write

gds.beta.k1coloring.write.estimate

K-Nearest Neighbors

gds.beta.knn.mutate

gds.beta.knn.mutate.estimate

gds.beta.knn.stats

gds.beta.knn.stats.estimate

gds.beta.knn.stream

gds.beta.knn.stream.estimate

gds.beta.knn.write

gds.beta.knn.write.estimate

Modularity Optimization

gds.beta.modularityOptimization.mutate

gds.beta.modularityOptimization.mutate.estimate

gds.beta.modularityOptimization.stream

gds.beta.modularityOptimization.stream.estimate

gds.beta.modularityOptimization.write

gds.beta.modularityOptimization.write.estimate

A.5. Alpha tier

The following table lists all alpha procedures in the GDS library:

Algorithm Procedure

All Shortest Paths

gds.alpha.allShortestPaths.stream

Article Rank

gds.alpha.articleRank.stream

gds.alpha.articleRank.write

Breadth First Search

gds.alpha.bfs.stream

Closeness Centrality

gds.alpha.closeness.stream

gds.alpha.closeness.write

gds.alpha.closeness.harmonic.stream

gds.alpha.closeness.harmonic.write

Collapse Path

gds.alpha.collapsePath.mutate

Degree Centrality

gds.alpha.degree.stream

gds.alpha.degree.write

Depth First Search

gds.alpha.dfs.stream

Eigenvector Centrality

gds.alpha.eigenvector.stream

gds.alpha.eigenvector.write

K-Shortest Paths

gds.alpha.kShortestPaths.stream

gds.alpha.kShortestPaths.write

Shortest Paths

gds.alpha.shortestPaths.stream

gds.alpha.shortestPaths.write

Random Walk

gds.alpha.randomWalk.stream

Strongly Connected Components

gds.alpha.scc.stream

gds.alpha.scc.write

Shortest Path

gds.alpha.shortestPath.stream

gds.alpha.shortestPath.write

A-Star

gds.alpha.shortestPath.astar.stream

Single Source Shortest Path

gds.alpha.shortestPath.deltaStepping.write

gds.alpha.shortestPath.deltaStepping.stream

Cosine Similarity

gds.alpha.similarity.cosine.stats

gds.alpha.similarity.cosine.stream

gds.alpha.similarity.cosine.write

Euclidean Similarity

gds.alpha.similarity.euclidean.stats

gds.alpha.similarity.euclidean.stream

gds.alpha.similarity.euclidean.write

Overlap Similarity

gds.alpha.similarity.overlap.stats

gds.alpha.similarity.overlap.stream

gds.alpha.similarity.overlap.write

Pearson Similarity

gds.alpha.similarity.pearson.stats

gds.alpha.similarity.pearson.stream

gds.alpha.similarity.pearson.write

Spanning Tree

gds.alpha.spanningTree.write

gds.alpha.spanningTree.kmax.write

gds.alpha.spanningTree.kmin.write

gds.alpha.spanningTree.maximum.write

gds.alpha.spanningTree.minimum.write

Approximate Nearest Neighbours

gds.alpha.ml.ann.stream

gds.alpha.ml.ann.write

Triangle Finding

gds.alpha.triangles

Node2Vec

gds.alpha.node2vec.stream

gds.alpha.node2vec.write

The following table lists all functions in the GDS library:

Group Function

Miscellaneous

gds.version

gds.debug.sysInfo

gds.list

Graph Operations

gds.graph.exists

Utilities

gds.util.asNode

gds.util.asNodes

gds.util.nodeProperty

gds.util.NaN

gds.util.infinity

gds.util.isFinite

gds.util.isInfinite

Link Prediction

gds.alpha.linkprediction.adamicAdar

gds.alpha.linkprediction.commonNeighbors

gds.alpha.linkprediction.preferentialAttachment

gds.alpha.linkprediction.resourceAllocation

gds.alpha.linkprediction.sameCommunity

gds.alpha.linkprediction.totalNeighbors

Encoding

gds.alpha.ml.oneHotEncoding

Similarity Functions

gds.alpha.similarity.cosine

gds.alpha.similarity.euclidean

gds.alpha.similarity.jaccard

gds.alpha.similarity.euclideanDistance

gds.alpha.similarity.overlap

gds.alpha.similarity.pearson