Skip to content

Commit

Permalink
[DOCS] Improves description for forecast_stats (#50729)
Browse files Browse the repository at this point in the history
Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
  • Loading branch information
szabosteve and lcawl authored Jan 9, 2020
1 parent 5031e47 commit d5fcb73
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,9 @@ expected number of data points. If your data contains many sparse buckets,
consider using a longer `bucket_span`.

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

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

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

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

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

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

`forecasts_stats`.`total`:::
(long) The number of forecasts currently available for this model.
(long) The number of individual forecasts currently available for this job. A
value of `1` or more indicates that forecasts exist.

`job_id`::
(string)
Expand Down

0 comments on commit d5fcb73

Please sign in to comment.