From b9d875bf681326570caf200fc2c1fd7449d1bdb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 13 Aug 2021 12:18:38 +0200 Subject: [PATCH] [DOCS] Updates description of model_prune_window property in ML shared (#76487) --- docs/reference/ml/ml-shared.asciidoc | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/reference/ml/ml-shared.asciidoc b/docs/reference/ml/ml-shared.asciidoc index 555e6ae278df3..1a84e2cf6cdb0 100644 --- a/docs/reference/ml/ml-shared.asciidoc +++ b/docs/reference/ml/ml-shared.asciidoc @@ -1230,9 +1230,13 @@ Only the specified `terms` can be viewed when using the Single Metric Viewer. end::model-plot-config-terms[] tag::model-prune-window[] -Advanced configuration option, which affects the pruning of models that have not -been updated for the given time duration. The value of this option must be at least -two whole multiples of `bucket_span`. If not set, a default value is not supplied. +Advanced configuration option. +Affects the pruning of models that have not been updated for the given time +duration. The value must be set to a multiple of the `bucket_span`. If set too +low, important information may be removed from the model. Typically, set to +`30d` or longer. If not set, model pruning only occurs if the model memory +status reaches the soft limit (`model_memory_limit`) or the hard limit +(`xpack.ml.max_model_memory_limit`). end::model-prune-window[] tag::model-snapshot-id[]