This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new 990872208e Clarify PageRank token class and times/maxIterations in
GraphComputer docs
990872208e is described below
commit 990872208e1b5532b13425f65f63eefa4d8d1e5f
Author: Stephen Mallette <[email protected]>
AuthorDate: Thu Sep 10 14:51:38 2026 +0000
Clarify PageRank token class and times/maxIterations in GraphComputer docs
The PageRankVertexProgram section used the PageRank.propertyName and
PageRank.times tokens in its pageRank()-step example without introducing
the PageRank token class or explaining how PageRank.times relates to the
program's maxIterations default of 20. Add a short introduction of the
PageRank class and a note explaining that PageRank.times sets the iteration
count, so a reader can understand the example from this section alone.
Assisted-by: Kiro:claude-opus-4.8
---
docs/src/reference/the-graphcomputer.asciidoc | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/docs/src/reference/the-graphcomputer.asciidoc
b/docs/src/reference/the-graphcomputer.asciidoc
index 95f5804b87..0d730e5c89 100644
--- a/docs/src/reference/the-graphcomputer.asciidoc
+++ b/docs/src/reference/the-graphcomputer.asciidoc
@@ -374,7 +374,10 @@ g = traversal().with(result.graph())
g.V().elementMap()
----
-Note that `GraphTraversal` provides a <<pagerank-step,`pageRank()`>>-step.
+Note that `GraphTraversal` provides a <<pagerank-step,`pageRank()`>>-step. The
`PageRank` class supplies the
+configuration tokens (`PageRank.propertyName`, `PageRank.times`) used to
parameterize the `pageRank()`-step, and
+these correspond respectively to the property name and `maxIterations`
settings of the `PageRankVertexProgram`
+described above.
[gremlin-groovy,modern]
----
@@ -388,6 +391,11 @@ g.V().pageRank().
elementMap()
----
+`PageRank.times` sets the number of PageRank iterations to run, equivalent to
the `maxIterations` setting of
+`PageRankVertexProgram` (which defaults to `20`). The `with(PageRank.times,
5)` above therefore runs only five
+iterations, yielding an approximate result that has not necessarily converged,
rather than the twenty iterations
+used by default.
+
[[peerpressurevertexprogram]]
=== PeerPressureVertexProgram
