Skip to content

Commit 912a18b

Browse files
adamnschadamnsch
authored
Merge pull request #5350 from adamnsch/jobid-docs
Add docs for new `jobId` configuration parameter
2 parents 659aad7 + 0c66463 commit 912a18b

File tree

12 files changed

+71
-44
lines changed

12 files changed

+71
-44
lines changed

‎doc/asciidoc/algorithms/common-configuration/common-mutate-configuration-named-graph.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.General configuration for algorithm execution on a named graph.
2-
[opts="header",cols="2,1,1m,1,4"]
2+
[opts="header",cols="3,2,3m,2,8"]
33
|===
44
| Name | Type | Default | Optional | Description
55

@@ -27,4 +27,6 @@ endif::[]
2727
ifeval::["{entity}" == "pregel"]
2828
| mutateProperty | String | "" | yes | The prefix used for all public properties in the PregelSchema.
2929
endif::[]
30+
31+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
3032
|===

‎doc/asciidoc/algorithms/common-configuration/common-stream-stats-configuration-named-graph.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.General configuration for algorithm execution on a named graph.
2-
[opts="header",cols="2,1,1m,1,4"]
2+
[opts="header",cols="3,2,3m,2,8"]
33
|===
44
| Name | Type | Default | Optional | Description
55

@@ -10,4 +10,5 @@ endif::[]
1010
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
1111
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
1212
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
13+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
1314
|===

‎doc/asciidoc/algorithms/common-configuration/common-train-configuration-named-graph.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
88
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
99
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
10+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
1011
|===

‎doc/asciidoc/algorithms/common-configuration/common-write-configuration-named-graph.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.General configuration for algorithm execution on a named graph.
2-
[opts="header",cols="2,1,1m,1,4"]
2+
[opts="header",cols="3,2,3m,2,8"]
33
|===
44
| Name | Type | Default | Optional | Description
55

@@ -28,4 +28,7 @@ endif::[]
2828
ifeval::["{entity}" == "pregel"]
2929
| writeProperty | String | "" | yes | The prefix used for all public properties in the PregelSchema.
3030
endif::[]
31+
32+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
33+
3134
|===

‎doc/asciidoc/common-usage/logging.adoc‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Second, if the `jobId` parameter is set it will show a detailed view for the giv
3838
The detailed view will produce a row for each step or task that job will perform during execution.
3939
It will also show how tasks are structured as a tree and print progress for each individual task.
4040

41+
4142
[[logging-progress-logging-syntax]]
4243
=== Syntax
4344

@@ -63,7 +64,7 @@ YIELD
6364
|===
6465

6566
.Results
66-
[opts="header",cols="1m,1,6"]
67+
[opts="header",cols="2m,1,6"]
6768
|===
6869
| Name | Type | Description
6970
| jobId | String | A generated identifier of the running task.
@@ -75,6 +76,13 @@ YIELD
7576
| elapsedTime | Duration | The duration from `timeStarted` to now.
7677
|===
7778

79+
[NOTE]
80+
====
81+
Some kinds of jobs that typically take while to run, like graph projections and running algorithms, takes an optional `jobId` in their configuration parameter maps.
82+
This can make tracking them easier as they will then be listed under the provided `jobId` in the `gds.beta.listProgress` results.
83+
For algorithms, see <<common-configuration-jobid, the `jobId` parameter documentation>> for more on this.
84+
====
85+
7886

7987
[[logging-progress-logging-examples]]
8088
=== Examples
@@ -97,6 +105,7 @@ YIELD
97105
| "d21bb4ca-e1e9-4a31-a487-42ac8c9c1a0d" | "Node2Vec" | "42%"
98106
|===
99107

108+
100109
[[logging-user-warnings]]
101110
[.alpha]
102111
== User Log
@@ -105,6 +114,7 @@ Hints and warnings can also be tracked through the GDS library and be accessed v
105114
The GDS library keeps track for each user their 100 most recent tasks that have generated hints or warnings and stores them in memory.
106115
When a user calls procedure `gds.alpha.userLog`, their respective list of generated hints and warnings is returned.
107116

117+
108118
[[userlog-syntax]]
109119
=== Syntax
110120

@@ -127,6 +137,7 @@ YIELD
127137
| message | String | A hint or warning associated with the task.
128138
|===
129139

140+
130141
[[userlog-examples]]
131142
=== Examples
132143

‎doc/asciidoc/common-usage/running-algorihms.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,7 @@ If the property already exists, existing values will be overwritten.
129129
writeConcurrency - Integer::
130130
In `write` mode this parameter controls the parallelism of write operations.
131131
The Default is `concurrency`
132+
133+
[[common-configuration-jobid]]
134+
jobId - String::
135+
An id for the job to be started can be provided in order for it to be more easily tracked with eg. GDS's <<logging, logging capabilities>>.

‎doc/asciidoc/machine-learning/linkprediction-pipeline/training.adoc‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,16 @@ include::../../algorithms/common-configuration/common-parameters-named-graph.ado
4949
.Configuration
5050
[opts="header",cols="1,1,1m,1,4"]
5151
|===
52-
| Name | Type | Default | Optional | Description
53-
| modelName | String | n/a | no | The name of the model to train, must not exist in the Model Catalog.
54-
| pipeline | String | n/a | no | The name of the pipeline to execute.
55-
| negativeClassWeight | Float | 1.0 | yes | Weight of negative examples in model evaluation. Positive examples have weight 1. More details <<linkprediction-pipelines-classimbalance, here>>.
56-
| metrics | List of String | [`AUCPR`] | no | <<linkprediction-pipelines-metrics,Metrics>> used to evaluate the models.
57-
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
58-
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
59-
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
60-
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
52+
| Name | Type | Default | Optional | Description
53+
| modelName | String | n/a | no | The name of the model to train, must not exist in the Model Catalog.
54+
| pipeline | String | n/a | no | The name of the pipeline to execute.
55+
| negativeClassWeight | Float | 1.0 | yes | Weight of negative examples in model evaluation. Positive examples have weight 1. More details <<linkprediction-pipelines-classimbalance, here>>.
56+
| metrics | List of String | [`AUCPR`] | no | <<linkprediction-pipelines-metrics,Metrics>> used to evaluate the models.
57+
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
58+
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
59+
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
60+
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
61+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the training's progress.
6162
|===
6263

6364

‎doc/asciidoc/machine-learning/node-property-prediction/nodeclassification-pipeline/training.adoc‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,16 @@ include::../../../algorithms/common-configuration/common-parameters-named-graph.
7373
.Configuration
7474
[opts="header",cols="1,1,1m,1,4"]
7575
|===
76-
| Name | Type | Default | Optional | Description
77-
| pipeline | String | n/a | no | The name of the pipeline to execute.
78-
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
79-
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
80-
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
81-
| targetProperty | String | n/a | no | The class of the node. Must be of type Integer.
82-
| metrics | List of String | n/a | no | <<nodeclassification-pipeline-metrics,Metrics>> used to evaluate the models.
83-
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
84-
| modelName | String | n/a | no | The name of the model to train, must not exist in the Model Catalog.
76+
| Name | Type | Default | Optional | Description
77+
| pipeline | String | n/a | no | The name of the pipeline to execute.
78+
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
79+
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
80+
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
81+
| targetProperty | String | n/a | no | The class of the node. Must be of type Integer.
82+
| metrics | List of String | n/a | no | <<nodeclassification-pipeline-metrics,Metrics>> used to evaluate the models.
83+
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
84+
| modelName | String | n/a | no | The name of the model to train, must not exist in the Model Catalog.
85+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the training's progress.
8586
|===
8687

8788
.Results

‎doc/asciidoc/machine-learning/node-property-prediction/noderegression-pipeline/training.adoc‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,16 @@ include::../../../algorithms/common-configuration/common-parameters-named-graph.
5959
.Configuration
6060
[opts="header",cols="1,1,1m,1,4"]
6161
|===
62-
| Name | Type | Default | Optional | Description
63-
| pipeline | String | n/a | no | The name of the pipeline to execute.
64-
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
65-
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
66-
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
67-
| targetProperty | String | n/a | no | The target property of the node. Must be of type Integer or Float.
68-
| metrics | List of String | n/a | no | <<noderegression-pipeline-metrics,Metrics>> used to evaluate the models.
69-
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
70-
| modelName | String | n/a | no | The name of the model to train, must not exist in the Model Catalog.
62+
| Name | Type | Default | Optional | Description
63+
| pipeline | String | n/a | no | The name of the pipeline to execute.
64+
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
65+
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
66+
| <<common-configuration-concurrency,concurrency>> | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
67+
| targetProperty | String | n/a | no | The target property of the node. Must be of type Integer or Float.
68+
| metrics | List of String | n/a | no | <<noderegression-pipeline-metrics,Metrics>> used to evaluate the models.
69+
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
70+
| modelName | String | n/a | no | The name of the model to train, must not exist in the Model Catalog.
71+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the training's progress.
7172
|===
7273

7374
.Results

‎doc/asciidoc/management-ops/graph-catalog/graph-project-cypher.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ CALL gds.graph.project.cypher(
6666
.Configuration
6767
[opts="header",cols="1,1,1,4"]
6868
|===
69-
| Name | Type | Default | Description
70-
| readConcurrency | Integer | 4 | The number of concurrent threads used for creating the graph.
71-
| validateRelationships | Boolean | true | Whether to throw an error if the `relationshipQuery` returns relationships between nodes not returned by the `nodeQuery`.
72-
| parameters | Map | {} | A map of user-defined query parameters that are passed into the node and relationship queries.
69+
| Name | Type | Default | Description
70+
| readConcurrency | Integer | 4 | The number of concurrent threads used for creating the graph.
71+
| validateRelationships | Boolean | true | Whether to throw an error if the `relationshipQuery` returns relationships between nodes not returned by the `nodeQuery`.
72+
| parameters | Map | {} | A map of user-defined query parameters that are passed into the node and relationship queries.
73+
| jobId | String | Generated internally | An ID that can be provided to more easily track the projection's progress.
7374
|===
7475

7576
.Results
@@ -577,4 +578,3 @@ CALL gds.graph.project.cypher(
577578
| "personSubsetViaParameters" | 2 | 1
578579
|===
579580
--
580-

0 commit comments

Comments
 (0)