From 47bf95cee3f8c40e981b39648928efaba319909f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 25 May 2020 09:09:47 +0200 Subject: [PATCH] [DOCS] Improves navigation between forecast APIs and adds short description. (#57035) --- .../ml/anomaly-detection/apis/forecast.asciidoc | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc index a1ad8f375162b..ed8f42cb03e5e 100644 --- a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc @@ -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 +<>. [NOTE] =============================== @@ -50,9 +57,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] processed. `expires_in`:: - (Optional, <>) 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, <>) 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}