honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Updates estimate model memory docs (#54574)

This commit is contained in:
István Zoltán Szabó 2020-04-01 15:53:53 +02:00
parent 95622d8782
commit 27f88fcdac
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc
View File

@ -29,22 +29,23 @@ configuration details and cardinality estimates for the fields it references.
`analysis_config` component of the body of this API, see <<put-analysisconfig,`analysis_config`>>. `analysis_config` component of the body of this API, see <<put-analysisconfig,`analysis_config`>>.
`max_bucket_cardinality`:: `max_bucket_cardinality`::
(Optional, object) Estimates of the highest cardinality in a single bucket (Required^\*^, object) Estimates of the highest cardinality in a single bucket
that will be observed for influencer fields over the time period that the job that will be observed for influencer fields over the time period that the job
analyzes data. To produce a good answer, values must be provided for analyzes data. To produce a good answer, values must be provided for
all influencer fields. It does not matter if values are provided for fields all influencer fields. It does not matter if values are provided for fields
that are not listed as `influencers`. If there are no `influencers` then that are not listed as `influencers`. +
`max_bucket_cardinality` can be omitted from the request. ^*^If there are no `influencers` then `max_bucket_cardinality` can be omitted
from the request.
`overall_cardinality`:: `overall_cardinality`::
(Optional, object) Estimates of the cardinality that will be observed for (Required^\*^, object) Estimates of the cardinality that will be observed for
fields over the whole time period that the job analyzes data. To produce fields over the whole time period that the job analyzes data. To produce a good
a good answer, values must be provided for fields referenced in the answer, values must be provided for fields referenced in the `by_field_name`,
`by_field_name`, `over_field_name` and `partition_field_name` of any `over_field_name` and `partition_field_name` of any detectors. It does not
detectors. It does not matter if values are provided for other fields. matter if values are provided for other fields. +
If no detectors have a `by_field_name`, `over_field_name` or ^*^If no detectors have a `by_field_name`, `over_field_name` or
`partition_field_name` then `overall_cardinality` can be omitted `partition_field_name` then `overall_cardinality` can be omitted from the
from the request. request.
[[ml-estimate-model-memory-example]] [[ml-estimate-model-memory-example]]
==== {api-examples-title} ==== {api-examples-title}
@ -82,6 +83,6 @@ The estimate returns the following result:
[source,console-result] [source,console-result]
---- ----
{ {
"model_memory_estimate": "45mb" "model_memory_estimate": "21mb"
} }
---- ----