[DOCS] Clarify model snapshot retention properties (#56477)

This commit is contained in:
Lisa Cawley 2020-05-11 07:41:47 -07:00 committed by lcawl
parent ba67ab3b64
commit 1474606b18

View File

@ -362,15 +362,14 @@ example, it can contain custom URL information as shown in
end::custom-settings[] end::custom-settings[]
tag::daily-model-snapshot-retention-after-days[] tag::daily-model-snapshot-retention-after-days[]
Advanced configuration option. Specifies a number of days between 0 and the Advanced configuration option, which affects the automatic removal of old model
value of `model_snapshot_retention_days`. After this period of time, only the first snapshots for this job. It specifies a period of time (in days) after which only
model snapshot per day is retained for this job. Age is calculated relative to the first snapshot per day is retained. This period is relative to the timestamp
the timestamp of the newest model snapshot. For new jobs, the default value is of the most recent snapshot for this job. Valid values range from `0` to
`1`, which means that all snapshots are retained for one day. Older snapshots `model_snapshot_retention_days`. For new jobs, the default value is `1`. For
are thinned out such that only one per day is retained. For jobs that were jobs created before version 7.8.0, the default value matches
created before this setting was available, the default value matches the `model_snapshot_retention_days`. For more information, refer to
`model_snapshot_retention_days` value, which preserves the original behavior {ml-docs}/ml-model-snapshots.html[Model snapshots].
and no thinning out of model snapshots occurs.
end::daily-model-snapshot-retention-after-days[] end::daily-model-snapshot-retention-after-days[]
tag::data-description[] tag::data-description[]
@ -1002,10 +1001,12 @@ Only the specified `terms` can be viewed when using the Single Metric Viewer.
end::model-plot-config-terms[] end::model-plot-config-terms[]
tag::model-snapshot-retention-days[] tag::model-snapshot-retention-days[]
Advanced configuration option. The period of time (in days) that model snapshots Advanced configuration option, which affects the automatic removal of old model
are retained. Age is calculated relative to the timestamp of the newest model snapshots for this job. It specifies the maximum period of time (in days) that
snapshot. The default value is `10`, which means snapshots that are ten days snapshots are retained. This period is relative to the timestamp of the most
older than the newest snapshot are deleted. recent snapshot for this job. The default value is `10`, which means snapshots
ten days older than the newest snapshot are deleted. For more information, refer
to {ml-docs}/ml-model-snapshots.html[Model snapshots].
end::model-snapshot-retention-days[] end::model-snapshot-retention-days[]
tag::model-timestamp[] tag::model-timestamp[]