Skip to content

Commit

Permalink
[DOCS] Updates description of model_prune_window property in ML shared (
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve authored Aug 13, 2021
1 parent 2ebe5cd commit b9d875b
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/reference/ml/ml-shared.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down

0 comments on commit b9d875b

Please sign in to comment.