You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ pip install graphdatascience
24
24
## Usage
25
25
26
26
What follows is a high level description of some of the operations supported by `graphdatascience`.
27
-
For extensive documentation of all capabilities, please refer to the [Python client chapter of the GDS Manual](https://neo4j.com/docs/graph-data-science/2.0-preview/python-client/).
27
+
For extensive documentation of all capabilities, please refer to the [Python client chapter of the GDS Manual](https://neo4j.com/docs/graph-data-science/current/python-client/).
28
28
29
29
Extensive end-to-end examples in Jupyter ready-to-run notebooks can be found in the [`examples` source directory](https://github.com/neo4j/graph-data-science-client/tree/main/examples):
30
30
@@ -33,7 +33,7 @@ Extensive end-to-end examples in Jupyter ready-to-run notebooks can be found in
33
33
34
34
### Imports and setup
35
35
36
-
The library wraps the [Neo4j Python driver](https://neo4j.com/docs/python-manual/2.0-preview/) with a `GraphDataScience` object through which most calls to GDS will be made.
36
+
The library wraps the [Neo4j Python driver](https://neo4j.com/docs/python-manual/current/) with a `GraphDataScience` object through which most calls to GDS will be made.
Supposing that we have some graph data in our Neo4j database, we can [project the graph into memory](https://neo4j.com/docs/graph-data-science/2.0-preview/graph-project/).
69
+
Supposing that we have some graph data in our Neo4j database, we can [project the graph into memory](https://neo4j.com/docs/graph-data-science/current/graph-project/).
70
70
71
71
```python
72
72
# Optionally we can estimate memory of the operation first
The `G` that is returned here is a `Graph` which on the client side represents the projection on the server side.
81
81
82
-
The analogous calls `gds.graph.project.cypher{,.estimate}` for [Cypher based projection](https://neo4j.com/docs/graph-data-science/2.0-preview/graph-project-cypher/) are also supported.
82
+
The analogous calls `gds.graph.project.cypher{,.estimate}` for [Cypher based projection](https://neo4j.com/docs/graph-data-science/current/graph-project-cypher/) are also supported.
83
83
84
84
85
85
### Running algorithms
86
86
87
-
We can take a projected graph, represented to us by a `Graph` object named `G`, and run [algorithms](https://neo4j.com/docs/graph-data-science/2.0-preview/algorithms/) on it.
87
+
We can take a projected graph, represented to us by a `Graph` object named `G`, and run [algorithms](https://neo4j.com/docs/graph-data-science/current/algorithms/) on it.
88
88
89
89
```python
90
90
# Optionally we can estimate memory of the operation first (if the algo supports it)
These calls take one positional argument and a number of keyword arguments depending on the algorithm.
99
-
The first (positional) argument is a `Graph`, and the keyword arguments map directly to the algorithm's [configuration map](https://neo4j.com/docs/graph-data-science/2.0-preview/common-usage/running-algos/#algorithms-syntax-configuration-parameters).
99
+
The first (positional) argument is a `Graph`, and the keyword arguments map directly to the algorithm's [configuration map](https://neo4j.com/docs/graph-data-science/current/common-usage/running-algos/#algorithms-syntax-configuration-parameters).
100
100
101
-
The other [algorithm execution modes](https://neo4j.com/docs/graph-data-science/2.0-preview/common-usage/running-algos/) - stats, stream and write - are also supported via analogous calls.
101
+
The other [algorithm execution modes](https://neo4j.com/docs/graph-data-science/current/common-usage/running-algos/) - stats, stream and write - are also supported via analogous calls.
102
102
The stream mode call returns a pandas DataFrame (with contents depending on the algorithm of course).
103
103
The mutate, stats and write mode calls however return a pandas Series with metadata about the algorithm execution.
104
104
105
105
106
106
#### Topological link prediction
107
107
108
-
The methods for doing [topological link prediction](https://neo4j.com/docs/graph-data-science/2.0-preview/algorithms/linkprediction/) are a bit different.
108
+
The methods for doing [topological link prediction](https://neo4j.com/docs/graph-data-science/current/algorithms/linkprediction/) are a bit different.
109
109
Just like in the GDS procedure API they do not take a graph as an argument, but rather two node references as positional arguments.
110
110
And they simply return the similarity score of the prediction just made as a float - not any kind of pandas data structure.
111
111
@@ -140,7 +140,7 @@ This includes support for models trained using pipelines (for Link Prediction an
140
140
141
141
#### Pipelines
142
142
143
-
There's native support for [Link prediction pipelines](https://neo4j.com/docs/graph-data-science/2.0-preview/algorithms/ml-models/linkprediction-pipelines/) and [Node classification pipelines](https://neo4j.com/docs/graph-data-science/2.0-preview/algorithms/ml-models/nodeclassification-pipelines/).
143
+
There's native support for [Link prediction pipelines](https://neo4j.com/docs/graph-data-science/current/algorithms/ml-models/linkprediction-pipelines/) and [Node classification pipelines](https://neo4j.com/docs/graph-data-science/current/algorithms/ml-models/nodeclassification-pipelines/).
144
144
Apart from the call to create a pipeline, the GDS native pipelines calls are represented by methods on pipeline Python objects.
145
145
Additionally to the standard GDS calls, there are several methods to query the pipeline for information about it.
146
146
@@ -188,7 +188,7 @@ Note that with GraphSAGE we call the `train` method directly and supply all trai
188
188
189
189
### Graph catalog utils
190
190
191
-
All procedures from the [GDS Graph catalog](https://neo4j.com/docs/graph-data-science/2.0-preview/management-ops/graph-catalog-ops/) are supported with `graphdatascience`.
191
+
All procedures from the [GDS Graph catalog](https://neo4j.com/docs/graph-data-science/current/management-ops/graph-catalog-ops/) are supported with `graphdatascience`.
192
192
Some examples are (where `G` is a `Graph`):
193
193
194
194
```python
@@ -206,7 +206,7 @@ The idea is to have a way of creating `Graph`s for already projected graphs, wit
206
206
207
207
### Pipeline catalog utils
208
208
209
-
All procedures from the [GDS Pipeline catalog](https://neo4j.com/docs/graph-data-science/2.0-preview/pipeline-catalog/) are supported with `graphdatascience`.
209
+
All procedures from the [GDS Pipeline catalog](https://neo4j.com/docs/graph-data-science/current/pipeline-catalog/) are supported with `graphdatascience`.
210
210
Some examples are (where `pipe` is a machine learning training pipeline object):
211
211
212
212
```python
@@ -224,7 +224,7 @@ The idea is to have a way of creating pipeline objects for already existing pipe
224
224
225
225
### Model catalog utils
226
226
227
-
All procedures from the [GDS Model catalog](https://neo4j.com/docs/graph-data-science/2.0-preview/model-catalog/) are supported with `graphdatascience`.
227
+
All procedures from the [GDS Model catalog](https://neo4j.com/docs/graph-data-science/current/model-catalog/) are supported with `graphdatascience`.
228
228
Some examples are (where `model` is a machine learning model object):
229
229
230
230
```python
@@ -243,7 +243,7 @@ The idea is to have a way of creating model objects for already loaded models, w
243
243
### Node matching without Cypher
244
244
245
245
When calling path finding or topological link prediction algorithms one has to provide specific nodes as input arguments.
246
-
When using the GDS procedure API directly to call such algorithms, typically Cypher `MATCH` statements are used in order to find valid representations of input nodes of interest, see eg. [this example in the GDS docs](https://neo4j.com/docs/graph-data-science/2.0-preview/algorithms/dijkstra-source-target/#algorithms-dijkstra-source-target-examples-stream).
246
+
When using the GDS procedure API directly to call such algorithms, typically Cypher `MATCH` statements are used in order to find valid representations of input nodes of interest, see eg. [this example in the GDS docs](https://neo4j.com/docs/graph-data-science/current/algorithms/dijkstra-source-target/#algorithms-dijkstra-source-target-examples-stream).
247
247
To simplify this, `graphdatascience` provides a utility function, `gds.find_node_id`, for letting one find nodes without using Cypher.
248
248
249
249
Below is an example of how this can be done (supposing `G` is a projected `Graph` with `City` nodes having `name` properties):
@@ -268,8 +268,8 @@ For more advanced filtering we recommend users do matching via Cypher's `MATCH`.
268
268
269
269
Operations known to not yet work with `graphdatascience`:
270
270
271
-
*[Numeric utility functions](https://neo4j.com/docs/graph-data-science/2.0-preview/management-ops/utility-functions/#utility-functions-numeric) (will never be supported)
272
-
*[Cypher on GDS](https://neo4j.com/docs/graph-data-science/2.0-preview/management-ops/create-cypher-db/) (might be supported in the future)
271
+
*[Numeric utility functions](https://neo4j.com/docs/graph-data-science/current/management-ops/utility-functions/#utility-functions-numeric) (will never be supported)
272
+
*[Cypher on GDS](https://neo4j.com/docs/graph-data-science/current/management-ops/create-cypher-db/) (might be supported in the future)
0 commit comments