Skip to content

Commit 4b77aba

Browse files
Mats-SXbrs96
andcommitted
Set Pregel Bootstrap to test future version
Also link correctly to 2.2 branch in docs Co-authored-by: Brian Shi <brian.shi@neotechnology.com>
1 parent a97d0d0 commit 4b77aba

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ OpenGDS is available to build, use, and extend under the constraints of the GNU
9595

9696
== Using the Pregel API
9797

98-
To build your own algorithms using the Pregel API (see at https://neo4j.com/docs/graph-data-science/current/algorithms/pregel-api/#algorithms-pregel-api-example[docs]), we recommend starting with the https://github.com/neo4j/graph-data-science/tree/1.8.0/examples/pregel-bootstrap[pregel-bootstrap project].
98+
To build your own algorithms using the Pregel API (see at https://neo4j.com/docs/graph-data-science/current/algorithms/pregel-api/#algorithms-pregel-api-example[docs]), we recommend starting with the https://github.com/neo4j/graph-data-science/tree/2.2/examples/pregel-bootstrap[pregel-bootstrap project].
9999

100100
NOTE: The module on `master` depends on the unpublished version of this library. The GDS version can be changed in the `build.gradle` of the `pregel-bootstrap` module.
101101

doc/modules/ROOT/pages/algorithms/pregel-api.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The introduction of a new Pregel algorithm can be separated in two main steps.
2828
First, we need to implement the algorithm using the Pregel Java API.
2929
Second, we need to expose the algorithm via a Cypher procedure to make use of it.
3030

31-
For an example on how to expose a custom Pregel computation via a Neo4j procedure, have a look at the https://github.com/neo4j/graph-data-science/tree/master/examples/pregel-example/src/main/java/org/neo4j/gds/beta/pregel[Pregel examples].
31+
For an example on how to expose a custom Pregel computation via a Neo4j procedure, have a look at the https://github.com/neo4j/graph-data-science/tree/{docs-version}/examples/pregel-example/src/main/java/org/neo4j/gds/beta/pregel[Pregel examples].
3232

3333
[[algorithms-pregel-api-java]]
3434
== Pregel Java API
@@ -509,7 +509,7 @@ For more details, please refer to the xref:algorithms/pregel-api.adoc#algorithms
509509
=== Building and installing a Neo4j plugin
510510

511511
In order to use a Pregel algorithm in Neo4j via a procedure, we need to package it as Neo4j plugin.
512-
The https://github.com/neo4j/graph-data-science/tree/master/examples/pregel-bootstrap[pregel-bootstrap] project is a good starting point.
512+
The https://github.com/neo4j/graph-data-science/tree/{docs-version}/examples/pregel-bootstrap[pregel-bootstrap] project is a good starting point.
513513
The `build.gradle` file within the project contains all the dependencies necessary to implement a Pregel algorithm and to generate corresponding procedures.
514514

515515
Make sure to change the `gdsVersion` and `neo4jVersion` according to your setup.
@@ -540,7 +540,7 @@ NOTE: Before `Neo4j 4.2`, the configuration setting is called `dbms.security.pro
540540
[[algorithms-pregel-api-example]]
541541
== Examples
542542

543-
The https://github.com/neo4j/graph-data-science/tree/master/examples/pregel-example[pregel-examples] module contains a set of examples for Pregel algorithms.
543+
The https://github.com/neo4j/graph-data-science/tree/{docs-version}/examples/pregel-example[pregel-examples] module contains a set of examples for Pregel algorithms.
544544
The algorithm implementations demonstrate the usage of the Pregel API.
545545
Along with each example, we provide test classes that can be used as a guideline on how to write tests for custom algorithms.
546546
To play around, we recommend copying one of the algorithms into the `pregel-bootstrap` project, build it and setup the plugin in Neo4j.

examples/pregel-bootstrap/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ plugins {
77

88
ext {
99
// Make sure these are the same as your installation of GDS and Neo4j
10-
gdsVersion = '2.2.3'
10+
gdsVersion = '2.2.4'
1111
neo4jVersion = '5.1.0'
1212

1313
// Necessary to generate value classes for Pregel configs

0 commit comments

Comments
 (0)