Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Improves description for forecast_stats #50729

Merged
merged 5 commits into from
Jan 9, 2020
Merged

[DOCS] Improves description for forecast_stats #50729

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e4a909
[DOCS] Improves description for forecast_stats.
szabosteve Jan 8, 2020
bef8e79
Update docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc
szabosteve Jan 9, 2020
22d0c9f
Update docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc
szabosteve Jan 9, 2020
66e0625
Update docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc
szabosteve Jan 9, 2020
04992e3
Update docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc
szabosteve Jan 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc
View file
Open in desktop
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. Omitted if forecasts do not exist.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

`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. Omitted if forecasts do not exist.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

`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. Omitted if forecasts do not exist.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

`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}. Omitted if forecasts do not exist.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

`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