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.

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

[DOCS] Moves forecast limitations out of overview #832

Merged
merged 1 commit into from
Jan 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 3 additions & 27 deletions docs/en/stack/ml/anomaly-detection/forecasting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,34 +31,10 @@ the forecast extends beyond the last record that was processed. By default, the
duration is 1 day. Typically the farther into the future that you forecast, the
lower the confidence levels become (that is to say, the bounds increase).
Eventually if the confidence levels are too low, the forecast stops.
For more information about limitations that affect your ability to create a
forecast, see <<ml-forecast-limitations>>.

You can also optionally specify when the forecast expires. By default, it
expires in 14 days and is deleted automatically thereafter. You can specify a
different expiration period by using the `expires_in` parameter in the
{ref}/ml-forecast.html[forecast {anomaly-jobs} API].

There are some limitations that affect your ability to create a forecast:

* You can generate only three forecasts concurrently. There is no limit to the
number of forecasts that you retain. Existing forecasts are not overwritten when
you create new forecasts. Rather, they are automatically deleted when they expire.
* If you use an `over_field_name` property in your {anomaly-job} (that is to say,
it's a _population job_), you cannot create a forecast.
* If you use any of the following analytical functions in your {anomaly-job},
you cannot create a forecast:
** `lat_long`
** `rare` and `freq_rare`
** `time_of_day` and `time_of_week`
+
--
For more information about any of these functions, see <<ml-functions>>.
--
* Forecasts run concurrently with real-time {ml} analysis. That is to say, {ml}
analysis does not stop while forecasts are generated. Forecasts can have an
impact on {anomaly-jobs}, however, especially in terms of memory usage. For this
reason, forecasts run only if the model memory status is acceptable.
* The {anomaly-job} must be open when you create a forecast. Otherwise, an error
occurs.
* If there is insufficient data to generate any meaningful predictions, an
error occurs. In general, forecasts that are created early in the learning phase
of the data analysis are less accurate.
{ref}/ml-forecast.html[forecast {anomaly-jobs} API].
53 changes: 31 additions & 22 deletions docs/en/stack/ml/anomaly-detection/limitations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -169,27 +169,6 @@ after creating or updating the {dfeed}, the {dfeed} continues to run with the
permissions that were associated with the original roles. For more information,
see <<ml-dfeeds>>.

[float]
=== Forecasts cannot be created for population jobs

If you use an `over_field_name` property in your job (that is to say, it's a
_population job_), you cannot create a forecast. If you try to create a forecast
for this type of job, an error occurs. For more information about forecasts,
see <<ml-forecasting>>.

[float]
=== Forecasts cannot be created for jobs that use geographic, rare, or time functions

If you use any of the following analytical functions in your job, you cannot
create a forecast:

* `lat_long`
* `rare` and `freq_rare`
* `time_of_day` and `time_of_week`

If you try to create a forecast for this type of job, an error occurs. For more
information about any of these functions, see <<ml-functions>>.

[float]
=== Jobs must be stopped before upgrades

Expand Down Expand Up @@ -254,4 +233,34 @@ jobs. Likewise, the {ref}/ml-get-datafeed.html[get {dfeeds} API] and the
When you create an {anomaly-job}, you cannot use a field with the
{ref}/date_nanos.html[`date_nanos` data type] as the `time_field` in the
`data_description` object. This limitation applies irrespective of whether you
create jobs in {kib} or by using APIs.
create jobs in {kib} or by using APIs.

[discrete]
[[ml-forecast-limitations]]
=== Forecast limitations

There are some limitations that affect your ability to create a forecast:

* You can generate only three forecasts concurrently. There is no limit to the
number of forecasts that you retain. Existing forecasts are not overwritten when
you create new forecasts. Rather, they are automatically deleted when they expire.
* If you use an `over_field_name` property in your {anomaly-job} (that is to say,
it's a _population job_), you cannot create a forecast.
* If you use any of the following analytical functions in your {anomaly-job},
you cannot create a forecast:
** `lat_long`
** `rare` and `freq_rare`
** `time_of_day` and `time_of_week`
+
--
For more information about any of these functions, see <<ml-functions>>.
--
* Forecasts run concurrently with real-time {ml} analysis. That is to say, {ml}
analysis does not stop while forecasts are generated. Forecasts can have an
impact on {anomaly-jobs}, however, especially in terms of memory usage. For this
reason, forecasts run only if the model memory status is acceptable.
* The {anomaly-job} must be open when you create a forecast. Otherwise, an error
occurs.
* If there is insufficient data to generate any meaningful predictions, an
error occurs. In general, forecasts that are created early in the learning phase
of the data analysis are less accurate.