Skip to content

Commit 922ec8e

Browse files
authored
[DOCS] Collapses nested objects in data frame analytics APIs (#54472) (#54526)
1 parent c9db2de commit 922ec8e

File tree

5 files changed

+227
-171
lines changed

5 files changed

+227
-171
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,13 @@ they are not included in the explanation.
5757
(Optional, string)
5858
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
5959

60-
6160
[[ml-explain-dfanalytics-request-body]]
6261
==== {api-request-body-title}
6362

6463
A {dataframe-analytics-config} as described in <<put-dfanalytics>>.
6564
Note that `id` and `dest` don't need to be provided in the context of this API.
6665

67-
66+
[role="child_attributes"]
6867
[[ml-explain-dfanalytics-results]]
6968
==== {api-response-body-title}
7069

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=from]
7070
(Optional, integer)
7171
include::{docdir}/ml/ml-shared.asciidoc[tag=size]
7272

73-
73+
[role="child_attributes"]
7474
[[ml-get-dfanalytics-results]]
7575
==== {api-response-body-title}
7676

docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=size]
7878
(Optional, string)
7979
include::{docdir}/ml/ml-shared.asciidoc[tag=tags]
8080

81-
81+
[role="child_attributes"]
8282
[[ml-get-inference-results]]
8383
==== {api-response-body-title}
8484

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

Lines changed: 93 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -80,192 +80,205 @@ using 4-fold cross validation.
8080
(Required, string)
8181
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define]
8282

83-
83+
[role="child_attributes"]
8484
[[ml-put-dfanalytics-request-body]]
8585
==== {api-request-body-title}
8686

8787
`allow_lazy_start`::
8888
(Optional, boolean)
8989
include::{docdir}/ml/ml-shared.asciidoc[tag=allow-lazy-start]
9090

91+
//Begin analysis
9192
`analysis`::
9293
(Required, object)
9394
The analysis configuration, which contains the information necessary to perform
9495
one of the following types of analysis: {classification}, {oldetection}, or
9596
{regression}.
96-
97-
`analysis`.`classification`:::
97+
+
98+
.Properties of `analysis`
99+
[%collapsible%open]
100+
====
101+
//Begin classification
102+
`classification`:::
98103
(Required^*^, object)
99104
The configuration information necessary to perform
100105
{ml-docs}/dfa-classification.html[{classification}].
101-
102106
+
103-
--
104107
TIP: Advanced parameters are for fine-tuning {classanalysis}. They are set
105108
automatically by <<ml-hyperparam-optimization,hyperparameter optimization>>
106109
to give minimum validation error. It is highly recommended to use the default
107110
values unless you fully understand the function of these parameters.
108-
109-
--
110-
111-
`analysis`.`classification`.`dependent_variable`::::
111+
+
112+
.Properties of `classification`
113+
[%collapsible%open]
114+
=====
115+
`dependent_variable`::::
112116
(Required, string)
113117
+
114-
--
115118
include::{docdir}/ml/ml-shared.asciidoc[tag=dependent-variable]
116-
119+
+
117120
The data type of the field must be numeric (`integer`, `short`, `long`, `byte`),
118121
categorical (`ip`, `keyword`, `text`), or boolean.
119-
--
120122

121-
`analysis`.`classification`.`eta`::::
123+
`eta`::::
122124
(Optional, double)
123125
include::{docdir}/ml/ml-shared.asciidoc[tag=eta]
124126

125-
`analysis`.`classification`.`feature_bag_fraction`::::
127+
`feature_bag_fraction`::::
126128
(Optional, double)
127129
include::{docdir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction]
128130

129-
`analysis`.`classification`.`max_trees`::::
130-
(Optional, integer)
131-
include::{docdir}/ml/ml-shared.asciidoc[tag=max-trees]
132-
133-
`analysis`.`classification`.`gamma`::::
131+
`gamma`::::
134132
(Optional, double)
135133
include::{docdir}/ml/ml-shared.asciidoc[tag=gamma]
136134

137-
`analysis`.`classification`.`lambda`::::
135+
`lambda`::::
138136
(Optional, double)
139137
include::{docdir}/ml/ml-shared.asciidoc[tag=lambda]
140138

141-
`analysis`.`classification`.`class_assignment_objective`::::
142-
(Optional, string)
143-
include::{docdir}/ml/ml-shared.asciidoc[tag=class-assignment-objective]
139+
`max_trees`::::
140+
(Optional, integer)
141+
include::{docdir}/ml/ml-shared.asciidoc[tag=max-trees]
144142

145-
`analysis`.`classification`.`num_top_classes`::::
143+
`num_top_classes`::::
146144
(Optional, integer)
147145
include::{docdir}/ml/ml-shared.asciidoc[tag=num-top-classes]
148146

149-
`analysis`.`classification`.`prediction_field_name`::::
150-
(Optional, string)
151-
include::{docdir}/ml/ml-shared.asciidoc[tag=prediction-field-name]
152-
153-
`analysis`.`classification`.`randomize_seed`::::
154-
(Optional, long)
155-
include::{docdir}/ml/ml-shared.asciidoc[tag=randomize-seed]
156-
157-
`analysis`.`classification`.`num_top_feature_importance_values`::::
147+
`num_top_feature_importance_values`::::
158148
(Optional, integer)
159149
Advanced configuration option. Specifies the maximum number of
160150
{ml-docs}/dfa-classification.html#dfa-classification-feature-importance[feature
161151
importance] values per document to return. By default, it is zero and no feature importance
162152
calculation occurs.
163153

164-
`analysis`.`classification`.`training_percent`::::
154+
`prediction_field_name`::::
155+
(Optional, string)
156+
include::{docdir}/ml/ml-shared.asciidoc[tag=prediction-field-name]
157+
158+
`randomize_seed`::::
159+
(Optional, long)
160+
include::{docdir}/ml/ml-shared.asciidoc[tag=randomize-seed]
161+
162+
`training_percent`::::
165163
(Optional, integer)
166164
include::{docdir}/ml/ml-shared.asciidoc[tag=training-percent]
167-
168-
`analysis`.`outlier_detection`:::
165+
//End classification
166+
=====
167+
//Begin outlier_detection
168+
`outlier_detection`:::
169169
(Required^*^, object)
170170
The configuration information necessary to perform
171171
{ml-docs}/dfa-outlier-detection.html[{oldetection}]:
172-
173-
`analysis`.`outlier_detection`.`compute_feature_influence`::::
172+
+
173+
.Properties of `outlier_detection`
174+
[%collapsible%open]
175+
=====
176+
`compute_feature_influence`::::
174177
(Optional, boolean)
175178
include::{docdir}/ml/ml-shared.asciidoc[tag=compute-feature-influence]
176-
177-
`analysis`.`outlier_detection`.`feature_influence_threshold`::::
179+
180+
`feature_influence_threshold`::::
178181
(Optional, double)
179182
include::{docdir}/ml/ml-shared.asciidoc[tag=feature-influence-threshold]
180183

181-
`analysis`.`outlier_detection`.`method`::::
184+
`method`::::
182185
(Optional, string)
183186
include::{docdir}/ml/ml-shared.asciidoc[tag=method]
184-
185-
`analysis`.`outlier_detection`.`n_neighbors`::::
187+
188+
`n_neighbors`::::
186189
(Optional, integer)
187190
include::{docdir}/ml/ml-shared.asciidoc[tag=n-neighbors]
188-
189-
`analysis`.`outlier_detection`.`outlier_fraction`::::
191+
192+
`outlier_fraction`::::
190193
(Optional, double)
191194
include::{docdir}/ml/ml-shared.asciidoc[tag=outlier-fraction]
192-
193-
`analysis`.`outlier_detection`.`standardization_enabled`::::
195+
196+
`standardization_enabled`::::
194197
(Optional, boolean)
195198
include::{docdir}/ml/ml-shared.asciidoc[tag=standardization-enabled]
196-
197-
`analysis`.`regression`:::
199+
//End outlier_detection
200+
=====
201+
//Begin regression
202+
`regression`:::
198203
(Required^*^, object)
199204
The configuration information necessary to perform
200205
{ml-docs}/dfa-regression.html[{regression}].
201206
+
202-
--
203207
TIP: Advanced parameters are for fine-tuning {reganalysis}. They are set
204208
automatically by <<ml-hyperparam-optimization,hyperparameter optimization>>
205209
to give minimum validation error. It is highly recommended to use the default
206210
values unless you fully understand the function of these parameters.
207-
208-
--
209-
210-
`analysis`.`regression`.`dependent_variable`::::
211+
+
212+
.Properties of `regression`
213+
[%collapsible%open]
214+
=====
215+
`dependent_variable`::::
211216
(Required, string)
212217
+
213-
--
214218
include::{docdir}/ml/ml-shared.asciidoc[tag=dependent-variable]
215-
219+
+
216220
The data type of the field must be numeric.
217-
--
218221

219-
`analysis`.`regression`.`eta`::::
222+
`eta`::::
220223
(Optional, double)
221224
include::{docdir}/ml/ml-shared.asciidoc[tag=eta]
222225

223-
`analysis`.`regression`.`feature_bag_fraction`::::
226+
`feature_bag_fraction`::::
224227
(Optional, double)
225228
include::{docdir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction]
226229

227-
`analysis`.`regression`.`max_trees`::::
228-
(Optional, integer)
229-
include::{docdir}/ml/ml-shared.asciidoc[tag=max-trees]
230-
231-
`analysis`.`regression`.`gamma`::::
230+
`gamma`::::
232231
(Optional, double)
233232
include::{docdir}/ml/ml-shared.asciidoc[tag=gamma]
234233

235-
`analysis`.`regression`.`lambda`::::
234+
`lambda`::::
236235
(Optional, double)
237236
include::{docdir}/ml/ml-shared.asciidoc[tag=lambda]
238237

239-
`analysis`.`regression`.`prediction_field_name`::::
240-
(Optional, string)
241-
include::{docdir}/ml/ml-shared.asciidoc[tag=prediction-field-name]
238+
`max_trees`::::
239+
(Optional, integer)
240+
include::{docdir}/ml/ml-shared.asciidoc[tag=max-trees]
242241

243-
`analysis`.`regression`.`num_top_feature_importance_values`::::
242+
`num_top_feature_importance_values`::::
244243
(Optional, integer)
245244
Advanced configuration option. Specifies the maximum number of
246245
{ml-docs}/dfa-regression.html#dfa-regression-feature-importance[feature importance]
247-
values per document to return. By default, it is zero and no feature importance calculation
248-
occurs.
246+
values per document to return. By default, it is zero and no feature importance
247+
calculation occurs.
249248

250-
`analysis`.`regression`.`training_percent`::::
251-
(Optional, integer)
252-
include::{docdir}/ml/ml-shared.asciidoc[tag=training-percent]
249+
`prediction_field_name`::::
250+
(Optional, string)
251+
include::{docdir}/ml/ml-shared.asciidoc[tag=prediction-field-name]
253252

254-
`analysis`.`regression`.`randomize_seed`::::
253+
`randomize_seed`::::
255254
(Optional, long)
256255
include::{docdir}/ml/ml-shared.asciidoc[tag=randomize-seed]
257-
256+
257+
`training_percent`::::
258+
(Optional, integer)
259+
include::{docdir}/ml/ml-shared.asciidoc[tag=training-percent]
260+
=====
261+
//End regression
262+
====
263+
//End analysis
264+
265+
//Begin analyzed_fields
258266
`analyzed_fields`::
259267
(Optional, object)
260268
include::{docdir}/ml/ml-shared.asciidoc[tag=analyzed-fields]
261-
262-
`analyzed_fields`.`excludes`:::
269+
+
270+
.Properties of `analyzed_fields`
271+
[%collapsible%open]
272+
====
273+
`excludes`:::
263274
(Optional, array)
264275
include::{docdir}/ml/ml-shared.asciidoc[tag=analyzed-fields-excludes]
265276
266-
`analyzed_fields`.`includes`:::
267-
(Optional, array)
277+
`includes`:::
278+
(Optional, array)
268279
include::{docdir}/ml/ml-shared.asciidoc[tag=analyzed-fields-includes]
280+
//End analyzed_fields
281+
====
269282

270283
`description`::
271284
(Optional, string)

0 commit comments

Comments
 (0)