Browse Source

[DOCS] Add memory limit details in update job API (#74517)

Co-authored-by: David Roberts <dave.roberts@elastic.co>
Lisa Cawley 4 years ago
parent
commit
64af39b759
1 changed files with 10 additions and 6 deletions
  1. 10 6
      docs/reference/ml/anomaly-detection/apis/update-job.asciidoc

+ 10 - 6
docs/reference/ml/anomaly-detection/apis/update-job.asciidoc

@@ -46,6 +46,8 @@ close the job, then reopen the job and restart the {dfeed} for the changes to ta
 (Optional, object)
 include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=analysis-limits]
 +
+You can update the `analysis_limits` only while the job is closed.
++
 .Properties of `analysis_limits`
 [%collapsible%open]
 ====
@@ -54,14 +56,16 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=analysis-limits]
 include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-ad]
 +
 --
-NOTE: You can update the `analysis_limits` only while the job is closed. The 
-`model_memory_limit` property value cannot be decreased below the current usage.
- 
-TIP: If the `memory_status` property in the
-<<ml-get-snapshot-results,`model_size_stats` object>> has a value of 
+[NOTE]
+=======
+* You cannot decrease the `model_memory_limit` value below the current usage. To
+determine the current usage, refer to the `model_bytes` value in
+the <<ml-get-job-stats,get job stats>> API.
+* If the `memory_status` property in the
+<<modelsizestats,`model_size_stats` object>> has a value of 
 `hard_limit`, this means that it was unable to process some data. You might want 
 to re-run the job with an increased `model_memory_limit`.
-
+=======
 --
 ====
 //End analysis_limits