Skip to content

Commit 6f3e36d

Browse files
committed
Point GDS manual doc links to current instead of 2.0-preview
1 parent 2c37c78 commit 6f3e36d

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ pip install graphdatascience
2424
## Usage
2525

2626
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/).
2828

2929
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):
3030

@@ -33,7 +33,7 @@ Extensive end-to-end examples in Jupyter ready-to-run notebooks can be found in
3333

3434
### Imports and setup
3535

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.
3737

3838
```python
3939
from graphdatascience import GraphDataScience
@@ -66,7 +66,7 @@ gds = GraphDataScience("neo4j+s://my-aura-ds.databases.neo4j.io:7687", auth=("ne
6666

6767
### Projecting a graph
6868

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/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/).
7070

7171
```python
7272
# Optionally we can estimate memory of the operation first
@@ -79,12 +79,12 @@ assert res["projectMillis"] >= 0
7979

8080
The `G` that is returned here is a `Graph` which on the client side represents the projection on the server side.
8181

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.
8383

8484

8585
### Running algorithms
8686

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.
8888

8989
```python
9090
# Optionally we can estimate memory of the operation first (if the algo supports it)
@@ -96,16 +96,16 @@ assert res["nodePropertiesWritten"] == G.node_count()
9696
```
9797

9898
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).
100100

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.
102102
The stream mode call returns a pandas DataFrame (with contents depending on the algorithm of course).
103103
The mutate, stats and write mode calls however return a pandas Series with metadata about the algorithm execution.
104104

105105

106106
#### Topological link prediction
107107

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.
109109
Just like in the GDS procedure API they do not take a graph as an argument, but rather two node references as positional arguments.
110110
And they simply return the similarity score of the prediction just made as a float - not any kind of pandas data structure.
111111

@@ -140,7 +140,7 @@ This includes support for models trained using pipelines (for Link Prediction an
140140

141141
#### Pipelines
142142

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/).
144144
Apart from the call to create a pipeline, the GDS native pipelines calls are represented by methods on pipeline Python objects.
145145
Additionally to the standard GDS calls, there are several methods to query the pipeline for information about it.
146146

@@ -188,7 +188,7 @@ Note that with GraphSAGE we call the `train` method directly and supply all trai
188188

189189
### Graph catalog utils
190190

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`.
192192
Some examples are (where `G` is a `Graph`):
193193

194194
```python
@@ -206,7 +206,7 @@ The idea is to have a way of creating `Graph`s for already projected graphs, wit
206206

207207
### Pipeline catalog utils
208208

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`.
210210
Some examples are (where `pipe` is a machine learning training pipeline object):
211211

212212
```python
@@ -224,7 +224,7 @@ The idea is to have a way of creating pipeline objects for already existing pipe
224224

225225
### Model catalog utils
226226

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`.
228228
Some examples are (where `model` is a machine learning model object):
229229

230230
```python
@@ -243,7 +243,7 @@ The idea is to have a way of creating model objects for already loaded models, w
243243
### Node matching without Cypher
244244

245245
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).
247247
To simplify this, `graphdatascience` provides a utility function, `gds.find_node_id`, for letting one find nodes without using Cypher.
248248

249249
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`.
268268

269269
Operations known to not yet work with `graphdatascience`:
270270

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)
273273

274274

275275
## License

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
]
2424

2525
project_urls = {
26-
"Documentation": "https://neo4j.com/docs/graph-data-science/2.0-preview/python-client/",
26+
"Documentation": "https://neo4j.com/docs/graph-data-science/current/python-client/",
2727
"Source": "https://github.com/neo4j/graph-data-science-client",
2828
"Bug Tracker": "https://github.com/neo4j/graph-data-science-client/issues",
2929
}

0 commit comments

Comments
 (0)