Skip to content

Commit 9e605cc

Browse files
committed
Apply review comments
1 parent 01a6784 commit 9e605cc

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc

+22-22
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,6 @@ result field to be present.
4242
[[ml-evaluate-dfanalytics-request-body]]
4343
==== {api-request-body-title}
4444

45-
`index`::
46-
(Required, object) Defines the `index` in which the evaluation will be
47-
performed.
48-
49-
`query`::
50-
(Optional, object) A query clause that retrieves a subset of data from the
51-
source index. See <<query-dsl>>.
52-
5345
`evaluation`::
5446
(Required, object) Defines the type of evaluation you want to perform.
5547
See <<ml-evaluate-dfanalytics-resources>>.
@@ -63,6 +55,14 @@ Available evaluation types:
6355

6456
--
6557

58+
`index`::
59+
(Required, object) Defines the `index` in which the evaluation will be
60+
performed.
61+
62+
`query`::
63+
(Optional, object) A query clause that retrieves a subset of data from the
64+
source index. See <<query-dsl>>.
65+
6666
[[ml-evaluate-dfanalytics-resources]]
6767
==== {dfanalytics-cap} evaluation resources
6868

@@ -93,19 +93,19 @@ document is an outlier.
9393
operating characteristic) score and optionally the curve. Default value is
9494
{"includes_curve": false}.
9595

96+
`confusion_matrix`:::
97+
(Optional, object) Set the different thresholds of the {olscore} at where
98+
the metrics (`tp` - true positive, `fp` - false positive, `tn` - true
99+
negative, `fn` - false negative) are calculated. Default value is
100+
{"at": [0.25, 0.50, 0.75]}.
101+
96102
`precision`:::
97103
(Optional, object) Set the different thresholds of the {olscore} at where
98104
the metric is calculated. Default value is {"at": [0.25, 0.50, 0.75]}.
99105

100106
`recall`:::
101107
(Optional, object) Set the different thresholds of the {olscore} at where
102108
the metric is calculated. Default value is {"at": [0.25, 0.50, 0.75]}.
103-
104-
`confusion_matrix`:::
105-
(Optional, object) Set the different thresholds of the {olscore} at where
106-
the metrics (`tp` - true positive, `fp` - false positive, `tn` - true
107-
negative, `fn` - false negative) are calculated. Default value is
108-
{"at": [0.25, 0.50, 0.75]}.
109109

110110

111111
[[regression-evaluation-resources]]
@@ -128,11 +128,11 @@ which outputs a prediction of values.
128128

129129
`mean_squared_error`:::
130130
(Optional, object) Average squared difference between the predicted values and the actual (`ground truth`) value.
131-
Read more on https://en.wikipedia.org/wiki/Mean_squared_error[Wikipedia]
131+
For more information, read https://en.wikipedia.org/wiki/Mean_squared_error[this wiki article].
132132

133133
`r_squared`:::
134134
(Optional, object) Proportion of the variance in the dependent variable that is predictable from the independent variables.
135-
Read more on https://en.wikipedia.org/wiki/Coefficient_of_determination[Wikipedia]
135+
For more information, read https://en.wikipedia.org/wiki/Coefficient_of_determination[this wiki article].
136136

137137

138138

@@ -160,16 +160,16 @@ belongs.
160160
Available metrics:
161161

162162
`accuracy`:::
163-
(Optional, object) Accuracy of predictions (per-class and overall)
163+
(Optional, object) Accuracy of predictions (per-class and overall).
164+
165+
`multiclass_confusion_matrix`:::
166+
(Optional, object) Multiclass confusion matrix.
164167

165168
`precision`:::
166-
(Optional, object) Precision of predictions (per-class and average)
169+
(Optional, object) Precision of predictions (per-class and average).
167170

168171
`recall`:::
169-
(Optional, object) Recall of predictions (per-class and average)
170-
171-
`multiclass_confusion_matrix`:::
172-
(Optional, object) Multiclass confusion matrix
172+
(Optional, object) Recall of predictions (per-class and average).
173173

174174

175175
////

0 commit comments

Comments
 (0)