Skip to content

Commit b90e491

Browse files
authored
[DOCS] Collapses nested objects in data frame analytics APIs (#54472)
1 parent 6c030dc commit b90e491

File tree

5 files changed

+225
-163
lines changed

5 files changed

+225
-163
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
@@ -58,14 +58,13 @@ they are not included in the explanation.
5858
(Optional, string)
5959
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
6060

61-
6261
[[ml-explain-dfanalytics-request-body]]
6362
==== {api-request-body-title}
6463

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

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

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

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

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

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
@@ -79,7 +79,7 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=size]
7979
(Optional, string)
8080
include::{docdir}/ml/ml-shared.asciidoc[tag=tags]
8181

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

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

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

83+
[role="child_attributes"]
8384
[[ml-put-dfanalytics-request-body]]
8485
==== {api-request-body-title}
8586

8687
`allow_lazy_start`::
8788
(Optional, boolean)
8889
include::{docdir}/ml/ml-shared.asciidoc[tag=allow-lazy-start]
8990

91+
//Begin analysis
9092
`analysis`::
9193
(Required, object)
9294
The analysis configuration, which contains the information necessary to perform
9395
one of the following types of analysis: {classification}, {oldetection}, or
9496
{regression}.
95-
//include::{docdir}/ml/ml-shared.asciidoc[tag=analysis]
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}].
101106
+
102-
--
103107
TIP: Advanced parameters are for fine-tuning {classanalysis}. They are set
104108
automatically by <<ml-hyperparam-optimization,hyperparameter optimization>>
105109
to give minimum validation error. It is highly recommended to use the default
106110
values unless you fully understand the function of these parameters.
107-
--
111+
+
112+
.Properties of `classification`
113+
[%collapsible%open]
114+
=====
115+
`class_assignment_objective`::::
116+
(Optional, string)
117+
include::{docdir}/ml/ml-shared.asciidoc[tag=class-assignment-objective]
108118

109-
`analysis`.`classification`.`dependent_variable`::::
119+
`dependent_variable`::::
110120
(Required, string)
111121
+
112-
--
113122
include::{docdir}/ml/ml-shared.asciidoc[tag=dependent-variable]
114-
123+
+
115124
The data type of the field must be numeric (`integer`, `short`, `long`, `byte`),
116125
categorical (`ip`, `keyword`, `text`), or boolean.
117-
--
118126

119-
`analysis`.`classification`.`eta`::::
127+
`eta`::::
120128
(Optional, double)
121129
include::{docdir}/ml/ml-shared.asciidoc[tag=eta]
122130

123-
`analysis`.`classification`.`feature_bag_fraction`::::
131+
`feature_bag_fraction`::::
124132
(Optional, double)
125133
include::{docdir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction]
126134

127-
`analysis`.`classification`.`max_trees`::::
128-
(Optional, integer)
129-
include::{docdir}/ml/ml-shared.asciidoc[tag=max-trees]
130-
131-
`analysis`.`classification`.`gamma`::::
135+
`gamma`::::
132136
(Optional, double)
133137
include::{docdir}/ml/ml-shared.asciidoc[tag=gamma]
134138

135-
`analysis`.`classification`.`lambda`::::
139+
`lambda`::::
136140
(Optional, double)
137141
include::{docdir}/ml/ml-shared.asciidoc[tag=lambda]
138142

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

143-
`analysis`.`classification`.`num_top_classes`::::
147+
`num_top_classes`::::
144148
(Optional, integer)
145149
include::{docdir}/ml/ml-shared.asciidoc[tag=num-top-classes]
146150

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

162-
`analysis`.`classification`.`training_percent`::::
158+
`prediction_field_name`::::
159+
(Optional, string)
160+
include::{docdir}/ml/ml-shared.asciidoc[tag=prediction-field-name]
161+
162+
`randomize_seed`::::
163+
(Optional, long)
164+
include::{docdir}/ml/ml-shared.asciidoc[tag=randomize-seed]
165+
166+
`training_percent`::::
163167
(Optional, integer)
164168
include::{docdir}/ml/ml-shared.asciidoc[tag=training-percent]
165-
166-
`analysis`.`outlier_detection`:::
169+
//End classification
170+
=====
171+
//Begin outlier_detection
172+
`outlier_detection`:::
167173
(Required^*^, object)
168174
The configuration information necessary to perform
169175
{ml-docs}/dfa-outlier-detection.html[{oldetection}]:
170-
171-
`analysis`.`outlier_detection`.`compute_feature_influence`::::
176+
+
177+
.Properties of `outlier_detection`
178+
[%collapsible%open]
179+
=====
180+
`compute_feature_influence`::::
172181
(Optional, boolean)
173182
include::{docdir}/ml/ml-shared.asciidoc[tag=compute-feature-influence]
174183

175-
`analysis`.`outlier_detection`.`feature_influence_threshold`::::
184+
`feature_influence_threshold`::::
176185
(Optional, double)
177186
include::{docdir}/ml/ml-shared.asciidoc[tag=feature-influence-threshold]
178187

179-
`analysis`.`outlier_detection`.`method`::::
188+
`method`::::
180189
(Optional, string)
181190
include::{docdir}/ml/ml-shared.asciidoc[tag=method]
182191

183-
`analysis`.`outlier_detection`.`n_neighbors`::::
192+
`n_neighbors`::::
184193
(Optional, integer)
185194
include::{docdir}/ml/ml-shared.asciidoc[tag=n-neighbors]
186195

187-
`analysis`.`outlier_detection`.`outlier_fraction`::::
196+
`outlier_fraction`::::
188197
(Optional, double)
189198
include::{docdir}/ml/ml-shared.asciidoc[tag=outlier-fraction]
190199

191-
`analysis`.`outlier_detection`.`standardization_enabled`::::
200+
`standardization_enabled`::::
192201
(Optional, boolean)
193202
include::{docdir}/ml/ml-shared.asciidoc[tag=standardization-enabled]
194-
195-
`analysis`.`regression`:::
203+
//End outlier_detection
204+
=====
205+
//Begin regression
206+
`regression`:::
196207
(Required^*^, object)
197208
The configuration information necessary to perform
198209
{ml-docs}/dfa-regression.html[{regression}].
199210
+
200-
--
201211
TIP: Advanced parameters are for fine-tuning {reganalysis}. They are set
202212
automatically by <<ml-hyperparam-optimization,hyperparameter optimization>>
203213
to give minimum validation error. It is highly recommended to use the default
204214
values unless you fully understand the function of these parameters.
205-
206-
--
207-
208-
`analysis`.`regression`.`dependent_variable`::::
215+
+
216+
.Properties of `regression`
217+
[%collapsible%open]
218+
=====
219+
`dependent_variable`::::
209220
(Required, string)
210221
+
211-
--
212222
include::{docdir}/ml/ml-shared.asciidoc[tag=dependent-variable]
213-
223+
+
214224
The data type of the field must be numeric.
215-
--
216225

217-
`analysis`.`regression`.`eta`::::
226+
`eta`::::
218227
(Optional, double)
219228
include::{docdir}/ml/ml-shared.asciidoc[tag=eta]
220229

221-
`analysis`.`regression`.`feature_bag_fraction`::::
230+
`feature_bag_fraction`::::
222231
(Optional, double)
223232
include::{docdir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction]
224233

225-
`analysis`.`regression`.`max_trees`::::
226-
(Optional, integer)
227-
include::{docdir}/ml/ml-shared.asciidoc[tag=max-trees]
228-
229-
`analysis`.`regression`.`gamma`::::
234+
`gamma`::::
230235
(Optional, double)
231236
include::{docdir}/ml/ml-shared.asciidoc[tag=gamma]
232237

233-
`analysis`.`regression`.`lambda`::::
238+
`lambda`::::
234239
(Optional, double)
235240
include::{docdir}/ml/ml-shared.asciidoc[tag=lambda]
236241

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

241-
`analysis`.`regression`.`num_top_feature_importance_values`::::
246+
`num_top_feature_importance_values`::::
242247
(Optional, integer)
243248
Advanced configuration option. Specifies the maximum number of
244249
{ml-docs}/dfa-regression.html#dfa-regression-feature-importance[feature importance]
245-
values per document to return. By default, it is zero and no feature importance calculation
246-
occurs.
250+
values per document to return. By default, it is zero and no feature importance
251+
calculation occurs.
247252

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

252-
`analysis`.`regression`.`randomize_seed`::::
257+
`randomize_seed`::::
253258
(Optional, long)
254259
include::{docdir}/ml/ml-shared.asciidoc[tag=randomize-seed]
255-
260+
261+
`training_percent`::::
262+
(Optional, integer)
263+
include::{docdir}/ml/ml-shared.asciidoc[tag=training-percent]
264+
=====
265+
//End regression
266+
====
267+
//End analysis
268+
269+
//Begin analyzed_fields
256270
`analyzed_fields`::
257271
(Optional, object)
258272
include::{docdir}/ml/ml-shared.asciidoc[tag=analyzed-fields]
259-
260-
`analyzed_fields`.`excludes`:::
273+
+
274+
.Properties of `analyzed_fields`
275+
[%collapsible%open]
276+
====
277+
`excludes`:::
261278
(Optional, array)
262279
include::{docdir}/ml/ml-shared.asciidoc[tag=analyzed-fields-excludes]
263280
264-
`analyzed_fields`.`includes`:::
281+
`includes`:::
265282
(Optional, array)
266283
include::{docdir}/ml/ml-shared.asciidoc[tag=analyzed-fields-includes]
284+
//End analyzed_fields
285+
====
267286

268287
`description`::
269288
(Optional, string)

0 commit comments

Comments
 (0)