Skip to content

Commit 0c66463

Browse files
committed
Remove UUID constraint from jobId docs
1 parent 32d71a2 commit 0c66463

File tree

11 files changed

+10
-11
lines changed

11 files changed

+10
-11
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ ifeval::["{entity}" == "pregel"]
2828
| mutateProperty | String | "" | yes | The prefix used for all public properties in the PregelSchema.
2929
endif::[]
3030

31-
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the algorithm's progress.
31+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
3232
|===

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +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 | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the algorithm's progress.
13+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
1414
|===

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +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 | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the algorithm's progress.
10+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
1111
|===

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ ifeval::["{entity}" == "pregel"]
2929
| writeProperty | String | "" | yes | The prefix used for all public properties in the PregelSchema.
3030
endif::[]
3131

32-
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the algorithm's progress.
32+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
3333

3434
|===

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,4 +133,3 @@ The Default is `concurrency`
133133
[[common-configuration-jobid]]
134134
jobId - String::
135135
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>>.
136-
A provided `jobId` must be a valid https://en.wikipedia.org/wiki/Universally_unique_identifier[universally unique identifier] in order to be accepted.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ include::../../algorithms/common-configuration/common-parameters-named-graph.ado
5858
| <<common-configuration-node-labels,nodeLabels>> | List of String | ['*'] | yes | Filter the named graph using the given node labels.
5959
| <<common-configuration-relationship-types,relationshipTypes>> | List of String | ['*'] | yes | Filter the named graph using the given relationship types.
6060
| <<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 | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the training's progress.
61+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the training's progress.
6262
|===
6363

6464

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ include::../../../algorithms/common-configuration/common-parameters-named-graph.
8282
| metrics | List of String | n/a | no | <<nodeclassification-pipeline-metrics,Metrics>> used to evaluate the models.
8383
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
8484
| 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 | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the training's progress.
85+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the training's progress.
8686
|===
8787

8888
.Results

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ include::../../../algorithms/common-configuration/common-parameters-named-graph.
6868
| metrics | List of String | n/a | no | <<noderegression-pipeline-metrics,Metrics>> used to evaluate the models.
6969
| randomSeed | Integer | n/a | yes | Seed for the random number generator used during training.
7070
| 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 | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the training's progress.
71+
| <<common-configuration-jobid, jobId>> | String | Generated internally | yes | An ID that can be provided to more easily track the training's progress.
7272
|===
7373

7474
.Results

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ CALL gds.graph.project.cypher(
7070
| readConcurrency | Integer | 4 | The number of concurrent threads used for creating the graph.
7171
| validateRelationships | Boolean | true | Whether to throw an error if the `relationshipQuery` returns relationships between nodes not returned by the `nodeQuery`.
7272
| parameters | Map | {} | A map of user-defined query parameters that are passed into the node and relationship queries.
73-
| jobId | String | Generated internally | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the projection's progress.
73+
| jobId | String | Generated internally | An ID that can be provided to more easily track the projection's progress.
7474
|===
7575

7676
.Results

doc/asciidoc/management-ops/graph-catalog/graph-project-subgraph.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ CALL gds.beta.graph.project.subgraph(
5555
|===
5656
| Name | Type | Default | Optional | Description
5757
| concurrency | Integer | 4 | yes | The number of concurrent threads used for filtering the graph.
58-
| jobId | String | Generated internally | yes | A https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] that can be provided to more easily track the projection's progress.
58+
| jobId | String | Generated internally | yes | An ID that can be provided to more easily track the projection's progress.
5959
|===
6060

6161
.Results

0 commit comments

Comments
 (0)