[DOCS] Reworks some parts of EMM API docs (#54872)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
István Zoltán Szabó 2020-04-08 09:50:12 +02:00
parent 37795d259a
commit 3a3effedc2
1 changed files with 28 additions and 22 deletions

View File

@ -6,8 +6,10 @@
<titleabbrev>Estimate model memory</titleabbrev> <titleabbrev>Estimate model memory</titleabbrev>
++++ ++++
Estimates the model memory an {anomaly-job} is likely to need based on analysis Makes an estimation of the memory usage for an {anomaly-job} model. It
configuration details and cardinality estimates for the fields it references. is based on analysis configuration details for the job and cardinality estimates for the
fields it references.
[[ml-estimate-model-memory-request]] [[ml-estimate-model-memory-request]]
==== {api-request-title} ==== {api-request-title}
@ -17,35 +19,39 @@ configuration details and cardinality estimates for the fields it references.
[[ml-estimate-model-memory-prereqs]] [[ml-estimate-model-memory-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_ml` or If the {es} {security-features} are enabled, you must have the following
`manage` cluster privileges to use this API. See equivalent privileges:
<<security-privileges>>.
* `manage_ml` or cluster: `manage`
For more information, see <<security-privileges>>.
[[ml-estimate-model-memory-request-body]] [[ml-estimate-model-memory-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
`analysis_config`:: `analysis_config`::
(Required, object) For a list of the properties that you can specify in the (Required, object)
`analysis_config` component of the body of this API, see <<put-analysisconfig,`analysis_config`>>. For a list of the properties that you can specify in the `analysis_config`
component of the body of this API, see <<put-analysisconfig,`analysis_config`>>.
`max_bucket_cardinality`:: `max_bucket_cardinality`::
(Required^\*^, object) Estimates of the highest cardinality in a single bucket (Required^\*^, object)
that will be observed for influencer fields over the time period that the job Estimates of the highest cardinality in a single bucket that is observed for
analyzes data. To produce a good answer, values must be provided for influencer fields over the time period that the job analyzes data. To produce a
all influencer fields. It does not matter if values are provided for fields good answer, values must be provided for all influencer fields. Providing values
that are not listed as `influencers`. + for fields that are not listed as `influencers` has no effect on the estimation. +
^*^If there are no `influencers` then `max_bucket_cardinality` can be omitted ^*^It can be omitted from the request if there are no `influencers`.
from the request.
`overall_cardinality`:: `overall_cardinality`::
(Required^\*^, object) Estimates of the cardinality that will be observed for (Required^\*^, object)
fields over the whole time period that the job analyzes data. To produce a good Estimates of the cardinality that is observed for fields over the whole time
answer, values must be provided for fields referenced in the `by_field_name`, period that the job analyzes data. To produce a good answer, values must be
`over_field_name` and `partition_field_name` of any detectors. It does not provided for fields referenced in the `by_field_name`, `over_field_name` and
matter if values are provided for other fields. + `partition_field_name` of any detectors. Providing values for other fields has
^*^If no detectors have a `by_field_name`, `over_field_name` or no effect on the estimation. +
`partition_field_name` then `overall_cardinality` can be omitted from the ^*^It can be omitted from the request if no detectors have a `by_field_name`,
request. `over_field_name` or `partition_field_name`.
[[ml-estimate-model-memory-example]] [[ml-estimate-model-memory-example]]
==== {api-examples-title} ==== {api-examples-title}