-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add documentation about forecast statistics shown as part of jobcounts.
- Loading branch information
Hendrik Muhs
committed
Jul 3, 2018
1 parent
a0f6ed5
commit f9804dc
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,6 +20,10 @@ progress of a job. | |
(object) An object that provides information about the size and contents of the model. | ||
See <<ml-modelsizestats,model size stats objects>> | ||
|
||
`forecasts_stats`:: | ||
(object) An object that provides statistical information about forecasts | ||
of this job. See <<ml-forecastsstats, forecasts stats objects>> | ||
|
||
`node`:: | ||
(object) For open jobs only, contains information about the node where the | ||
job runs. See <<ml-stats-node,node object>>. | ||
|
@@ -177,6 +181,33 @@ NOTE: The `over` field values are counted separately for each detector and parti | |
`timestamp`:: | ||
(date) The timestamp of the `model_size_stats` according to the timestamp of the data. | ||
|
||
[float] | ||
[[ml-forecastsstats]] | ||
==== Forecasts Stats Objects | ||
|
||
The `forecasts_stats` object shows statistics about forecasts. It has the following properties: | ||
|
||
`total`:: | ||
(long) The number of forecasts currently available for this model. | ||
|
||
`forecasted_jobs`:: | ||
(long) Number of jobs that have at least one forecast. | ||
This comment has been minimized.
Sorry, something went wrong. |
||
|
||
`memory_bytes`:: | ||
(object) Statistics about the memory usage: min, max, avg and total. | ||
|
||
`records`:: | ||
(object) Statistics about the number of forecast records: min, max, avg and total. | ||
This comment has been minimized.
Sorry, something went wrong.
lcawl
Contributor
|
||
|
||
`processing_time_ms`:: | ||
(object) Statistics about the forecast runtime in milliseconds: min, max, avg and total. | ||
|
||
`status`:: | ||
(object) Counts per forecast status, for example: {"finished" : 2}. | ||
|
||
NOTE: `memory_bytes`, `records`, `processing_time_ms`, `status` require at least 1 forecast, otherwise | ||
This comment has been minimized.
Sorry, something went wrong. |
||
these fields are ommitted. | ||
|
||
[float] | ||
[[ml-stats-node]] | ||
==== Node Objects | ||
|
I'd add "The number" here too to match the description for total.