Skip to content

Commit d5fcb73

Browse files
szabostevelcawl
andauthored
[DOCS] Improves description for forecast_stats (#50729)
Co-Authored-By: Lisa Cawley <[email protected]>
1 parent 5031e47 commit d5fcb73

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,9 @@ expected number of data points. If your data contains many sparse buckets,
148148
consider using a longer `bucket_span`.
149149

150150
[[forecastsstats]]`forecasts_stats`::
151-
(object) An object that provides statistical information about forecasts
152-
of this job. It has the following properties:
151+
(object) An object that provides statistical information about forecasts
152+
belonging to this job. Some statistics are omitted if no forecasts have been
153+
made. It has the following properties:
153154
+
154155
--
155156
NOTE: Unless there is at least one forecast, `memory_bytes`, `records`,
@@ -158,24 +159,28 @@ NOTE: Unless there is at least one forecast, `memory_bytes`, `records`,
158159
--
159160

160161
`forecasts_stats`.`forecasted_jobs`:::
161-
(long) The number of jobs that have at least one forecast.
162+
(long) A value of `0` indicates that forecasts do not exist for this job. A
163+
value of `1` indicates that at least one forecast exists.
162164

163165
`forecasts_stats`.`memory_bytes`:::
164-
(object) Statistics about the memory usage: minimum, maximum, average and total.
166+
(object) The `avg`, `min`, `max` and `total` memory usage in bytes for forecasts
167+
related to this job. If there are no forecasts, this property is omitted.
165168

166169
`forecasts_stats`.`records`:::
167-
(object) Statistics about the number of forecast records: minimum, maximum,
168-
average and total.
170+
(object) The `avg`, `min`, `max` and `total` number of model_forecast documents
171+
written for forecasts related to this job. If there are no forecasts, this property is omitted.
169172

170173
`forecasts_stats`.`processing_time_ms`:::
171-
(object) Statistics about the forecast runtime in milliseconds: minimum, maximum,
172-
average and total.
174+
(object) The `avg`, `min`, `max` and `total` runtime in milliseconds for
175+
forecasts related to this job. If there are no forecasts, this property is omitted.
173176

174177
`forecasts_stats`.`status`:::
175-
(object) Counts per forecast status. For example: `{"finished" : 2}`.
178+
(object) The count of forecasts by their status. For example:
179+
{"finished" : 2, "started" : 1}. If there are no forecasts, this property is omitted.
176180

177181
`forecasts_stats`.`total`:::
178-
(long) The number of forecasts currently available for this model.
182+
(long) The number of individual forecasts currently available for this job. A
183+
value of `1` or more indicates that forecasts exist.
179184

180185
`job_id`::
181186
(string)

0 commit comments

Comments
 (0)