Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] [DOCS] Updates description of model_prune_window property in ML shared (#76487) #76488

Merged
merged 1 commit into from
Aug 13, 2021
Merged

[7.x] [DOCS] Updates description of model_prune_window property in ML shared (#76487) #76488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/reference/ml/ml-shared.asciidoc
View file
Open in desktop
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