Skip to content

Commit fdf0270

Browse files
committed
Fix wrongly documented model info result columns
1 parent 6cb8870 commit fdf0270

File tree

3 files changed

+19
-20
lines changed

3 files changed

+19
-20
lines changed

doc/modules/ROOT/pages/machine-learning/linkprediction-pipelines/training.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,12 @@ The `modelInfo` return field has the following algorithm-specific subfields:
9090
.Fields of modelInfo
9191
[opts="header",cols="1,1,6"]
9292
|===
93-
| Name | Type | Description
94-
| modelName | String | The name of the trained model.
95-
| modelType | String | The type of the trained model.
96-
| bestParameters | Map | The model parameters which performed best on average on validation folds according to the primary metric.
97-
| metrics | Map | Map from metric description to evaluated metrics for the winning model over the subsets of the data, see below.
98-
| trainingPipeline | Map | The pipeline used for the training.
93+
| Name | Type | Description
94+
| modelName | String | The name of the trained model.
95+
| modelType | String | The type of the trained model.
96+
| bestParameters | Map | The model parameters which performed best on average on validation folds according to the primary metric.
97+
| metrics | Map | Map from metric description to evaluated metrics for the winning model over the subsets of the data, see below.
98+
| pipeline | Map | Steps to produce input features for the pipeline model.
9999
|===
100100

101101

@@ -105,7 +105,7 @@ The structure of `modelInfo` is:
105105
----
106106
{
107107
bestParameters: Map, // <1>
108-
trainingPipeline: Map // <2>
108+
pipeline: Map // <2>
109109
metrics: { // <3>
110110
AUCPR: {
111111
test: Float, // <4>

doc/modules/ROOT/pages/machine-learning/node-property-prediction/nodeclassification-pipelines/training.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,13 @@ The `modelInfo` return field has the following algorithm-specific subfields:
116116
.Fields of modelInfo
117117
[opts="header",cols="1,1,6"]
118118
|===
119-
| Name | Type | Description
120-
| modelName | String | The name of the trained model.
121-
| modelType | String | The type of the trained model.
122-
| classes | List of Integer | Sorted list of class ids which are the distinct values of `targetProperty` over the entire graph.
123-
| bestParameters | Map | The model parameters which performed best on average on validation folds according to the primary metric.
124-
| metrics | Map | Map from metric description to evaluated metrics for the winning model over the subsets of the data, see below.
125-
| trainingPipeline | Map | The pipeline used for the training.
119+
| Name | Type | Description
120+
| modelName | String | The name of the trained model.
121+
| modelType | String | The type of the trained model.
122+
| classes | List of Integer | Sorted list of class ids which are the distinct values of `targetProperty` over the entire graph.
123+
| bestParameters | Map | The model parameters which performed best on average on validation folds according to the primary metric.
124+
| metrics | Map | Map from metric description to evaluated metrics for the winning model over the subsets of the data, see below.
125+
| pipeline | Map | Steps to produce input features for the pipeline model.
126126
|===
127127

128128
The structure of `modelInfo` is:
@@ -131,7 +131,7 @@ The structure of `modelInfo` is:
131131
----
132132
{
133133
bestParameters: Map, // <1>
134-
trainingPipeline: Map // <2>
134+
pipeline: Map // <2>
135135
classes: List of Integer, // <3>
136136
metrics: { // <4>
137137
<METRIC_NAME>: { // <5>

doc/modules/ROOT/pages/machine-learning/node-property-prediction/noderegression-pipelines/training.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ The `modelInfo` return field has the following algorithm-specific subfields:
9393
.Model info fields
9494
[opts="header",cols="1,1,6"]
9595
|===
96-
| Name | Type | Description
97-
| bestParameters | Map | The model parameters which performed best on average on validation folds according to the primary metric.
98-
| metrics | Map | Map from metric description to evaluated metrics for the winning model over the subsets of the data, see below.
99-
| pipeline | Map | The pipeline used to generate and select the node features.
96+
| Name | Type | Description
97+
| bestParameters | Map | The model parameters which performed best on average on validation folds according to the primary metric.
98+
| metrics | Map | Map from metric description to evaluated metrics for the winning model over the subsets of the data, see below.
99+
| pipeline | Map | Steps to produce input features for the pipeline model.
100100
|===
101101

102102
The structure of `modelInfo` is:
@@ -348,4 +348,3 @@ RETURN
348348
As we can see, the results indicate a lower mean square error for the random forest model, compared to `nr-pipeline-model` in earlier section.
349349
The change is due to the embeddings taking into account more contextual information.
350350
While this is a toy example, additional context can sometimes provide valuable information to pipeline steps, resulting in better performance.
351-

0 commit comments

Comments
 (0)