diff --git a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc index dd3946971853..472c893ac28b 100644 --- a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc @@ -21,7 +21,8 @@ experimental[] [[ml-delete-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: +If the {es} {security-features} are enabled, you must have the following +built-in roles or equivalent privileges: * `machine_learning_admin` * `kibana_user` (UI only) diff --git a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc index 086c093927bd..8b9aad01c8f2 100644 --- a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc @@ -22,7 +22,8 @@ experimental[] [[ml-delete-inference-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: +If the {es} {security-features} are enabled, you must have the following +built-in roles or equivalent privileges: * `machine_learning_admin` * `kibana_user` (UI only) diff --git a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc index 0f4f5b222e56..c331d9bda7aa 100644 --- a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc @@ -22,7 +22,8 @@ experimental[] [[ml-evaluate-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following privileges: +If the {es} {security-features} are enabled, you must have the following +privileges: * cluster: `monitor_ml` diff --git a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc index f2f570cadafb..ea3ed38d85c2 100644 --- a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc @@ -28,7 +28,8 @@ experimental[] [[ml-explain-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following privileges: +If the {es} {security-features} are enabled, you must have the following +privileges: * cluster: `monitor_ml` diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index 508e1072349b..e302f808f6f5 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -28,7 +28,8 @@ experimental[] [[ml-get-dfanalytics-stats-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following privileges: +If the {es} {security-features} are enabled, you must have the following +privileges: * cluster: `monitor_ml` diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc index dfcf64759122..df11cc686a61 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc @@ -27,7 +27,8 @@ experimental[] [[ml-get-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following privileges: +If the {es} {security-features} are enabled, you must have the following +privileges: * cluster: `monitor_ml` diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc index 8bc882084332..58dfb2e60ca0 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc @@ -29,7 +29,8 @@ experimental[] [[ml-get-inference-stats-prereq]] ==== {api-prereq-title} -Required privileges which should be added to a custom role: +If the {es} {security-features} are enabled, you must have the following +privileges: * cluster: `monitor_ml` diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc index e972cf040e22..047ffd40332e 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc @@ -29,7 +29,8 @@ experimental[] [[ml-get-inference-prereq]] ==== {api-prereq-title} -Required privileges which should be added to a custom role: +If the {es} {security-features} are enabled, you must have the following +privileges: * cluster: `monitor_ml` diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index 83b2ff4b6583..24149372e0e9 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -20,7 +20,8 @@ experimental[] [[ml-put-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: +If the {es} {security-features} are enabled, you must have the following +built-in roles and privileges: * `machine_learning_admin` * `kibana_user` (UI only) @@ -66,12 +67,11 @@ upper bound on the improvement in validation loss. A fixed number of rounds is used for optimization which depends on the number of parameters being optimized. The optimization starts with random search, then Bayesian optimization is performed that is targeting maximum expected -improvement. If you override any parameters, -//TBD: What is meant by overriding them? Explicitly setting the parameter instead of letting it take the default? -the optimization calculates the value of the remaining parameters accordingly -and uses the value you provided for the overridden parameter. The number of -rounds are reduced respectively. The validation error is estimated in each round -by using 4-fold cross validation. +improvement. If you override any parameters by explicitely setting it, the +optimization calculates the value of the remaining parameters accordingly and +uses the value you provided for the overridden parameter. The number of rounds +are reduced respectively. The validation error is estimated in each round by +using 4-fold cross validation. [[ml-put-dfanalytics-path-params]] ==== {api-path-parms-title} @@ -104,7 +104,6 @@ TIP: Advanced parameters are for fine-tuning {classanalysis}. They are set automatically by <> to give minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters. - -- `analysis`.`classification`.`dependent_variable`:::: diff --git a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc index f2b1586c31b2..7b37719011bc 100644 --- a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc @@ -20,7 +20,8 @@ experimental[] [[ml-start-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: +If the {es} {security-features} are enabled, you must have the following +built-in roles and privileges: * `machine_learning_admin` * `kibana_user` (UI only) diff --git a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc index 741e4551ceb6..2f3087697213 100644 --- a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc @@ -24,7 +24,8 @@ experimental[] [[ml-stop-dfanalytics-prereq]] ==== {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: +If the {es} {security-features} are enabled, you must have the following +built-in roles or equivalent privileges: * `machine_learning_admin` * `kibana_user` (UI only) diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index d37d6dda8ee8..681ab746c193 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -3,7 +3,7 @@ == Definitions The role mappings resource definition you can find below is used in APIs related -to security features. +to {security-features}. * <>