2019-08-21 08:27:36 -04:00
|
|
|
--
|
|
|
|
|
:api: estimate-memory-usage
|
|
|
|
|
:request: PutDataFrameAnalyticsRequest
|
|
|
|
|
:response: EstimateMemoryUsageResponse
|
|
|
|
|
--
|
2019-09-10 11:26:56 -04:00
|
|
|
[role="xpack"]
|
2019-08-21 08:27:36 -04:00
|
|
|
[id="{upid}-{api}"]
|
|
|
|
|
=== Estimate memory usage API
|
|
|
|
|
|
2019-09-16 13:00:44 -04:00
|
|
|
Estimates memory usage of {dfanalytics}.
|
2019-08-21 08:27:36 -04:00
|
|
|
Estimation results can be used when deciding the appropriate value for `model_memory_limit` setting later on.
|
|
|
|
|
|
|
|
|
|
The API accepts an +{request}+ object and returns an +{response}+.
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2019-09-16 13:00:44 -04:00
|
|
|
==== Estimate memory usage request
|
2019-08-21 08:27:36 -04:00
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
<1> Constructing a new request containing a {dataframe-analytics-config} for which memory usage estimation should be performed
|
|
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
|
|
==== Response
|
|
|
|
|
|
|
|
|
|
The returned +{response}+ contains the memory usage estimates.
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
<1> Estimated memory usage under the assumption that the whole {dfanalytics} should happen in memory (i.e. without overflowing to disk).
|
|
|
|
|
<2> Estimated memory usage under the assumption that overflowing to disk is allowed during {dfanalytics}.
|
