Skip to content

Commit

Permalink
[DOCS] Improves navigation between forecast APIs and adds short descr…
Browse files Browse the repository at this point in the history
…iption. (elastic#57035)
  • Loading branch information
szabosteve committed May 25, 2020
1 parent 05c0195 commit 47bf95c
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/reference/ml/anomaly-detection/apis/forecast.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@ Predicts the future behavior of a time series by using its historical behavior.
[[ml-forecast-desc]]
==== {api-description-title}

See {ml-docs}/ml-overview.html#ml-forecasting[Forecasting the future].
You can create a forecast job based on an {anomaly-job} to extrapolate future
behavior. Refer to
{ml-docs}/ml-overview.html#ml-forecasting[Forecasting the future] and
{ml-docs}/ml-limitations.html#ml-forecast-limitations[forecast limitations] to
learn more.

You can delete a forecast by using the
<<ml-delete-forecast,Delete forecast API>>.

[NOTE]
===============================
Expand All @@ -50,9 +57,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
processed.

`expires_in`::
(Optional, <<time-units, time units>>) The period of time that forecast results are retained.
After a forecast expires, the results are deleted. The default value is 14 days.
If set to a value of `0`, the forecast is never automatically deleted.
(Optional, <<time-units, time units>>) The period of time that forecast
results are retained. After a forecast expires, the results are deleted. The
default value is 14 days. If set to a value of `0`, the forecast is never
automatically deleted.


[[ml-forecast-example]]
==== {api-examples-title}
Expand Down

0 comments on commit 47bf95c

Please sign in to comment.