Skip to content

Commit 2e28bf5

Browse files
committed
[DOCS] Clarify model snapshot retention properties (#56477)
1 parent 6d40228 commit 2e28bf5

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

docs/reference/ml/ml-shared.asciidoc

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -362,15 +362,14 @@ example, it can contain custom URL information as shown in
362362
end::custom-settings[]
363363

364364
tag::daily-model-snapshot-retention-after-days[]
365-
Advanced configuration option. Specifies a number of days between 0 and the
366-
value of `model_snapshot_retention_days`. After this period of time, only the first
367-
model snapshot per day is retained for this job. Age is calculated relative to
368-
the timestamp of the newest model snapshot. For new jobs, the default value is
369-
`1`, which means that all snapshots are retained for one day. Older snapshots
370-
are thinned out such that only one per day is retained. For jobs that were
371-
created before this setting was available, the default value matches the
372-
`model_snapshot_retention_days` value, which preserves the original behavior
373-
and no thinning out of model snapshots occurs.
365+
Advanced configuration option, which affects the automatic removal of old model
366+
snapshots for this job. It specifies a period of time (in days) after which only
367+
the first snapshot per day is retained. This period is relative to the timestamp
368+
of the most recent snapshot for this job. Valid values range from `0` to
369+
`model_snapshot_retention_days`. For new jobs, the default value is `1`. For
370+
jobs created before version 7.8.0, the default value matches
371+
`model_snapshot_retention_days`. For more information, refer to
372+
{ml-docs}/ml-model-snapshots.html[Model snapshots].
374373
end::daily-model-snapshot-retention-after-days[]
375374

376375
tag::data-description[]
@@ -1002,10 +1001,12 @@ Only the specified `terms` can be viewed when using the Single Metric Viewer.
10021001
end::model-plot-config-terms[]
10031002

10041003
tag::model-snapshot-retention-days[]
1005-
Advanced configuration option. The period of time (in days) that model snapshots
1006-
are retained. Age is calculated relative to the timestamp of the newest model
1007-
snapshot. The default value is `10`, which means snapshots that are ten days
1008-
older than the newest snapshot are deleted.
1004+
Advanced configuration option, which affects the automatic removal of old model
1005+
snapshots for this job. It specifies the maximum period of time (in days) that
1006+
snapshots are retained. This period is relative to the timestamp of the most
1007+
recent snapshot for this job. The default value is `10`, which means snapshots
1008+
ten days older than the newest snapshot are deleted. For more information, refer
1009+
to {ml-docs}/ml-model-snapshots.html[Model snapshots].
10091010
end::model-snapshot-retention-days[]
10101011

10111012
tag::model-timestamp[]

0 commit comments

Comments
 (0)