diff --git a/docs/user/index.asciidoc b/docs/user/index.asciidoc index 1ee1cd0d2ae3f8..3be91b9064576b 100644 --- a/docs/user/index.asciidoc +++ b/docs/user/index.asciidoc @@ -16,7 +16,7 @@ include::dashboard.asciidoc[] include::canvas.asciidoc[] -include::{kib-repo-dir}/ml/index.asciidoc[] +include::ml/index.asciidoc[] include::{kib-repo-dir}/maps/index.asciidoc[] diff --git a/docs/ml/creating-df-kib.asciidoc b/docs/user/ml/creating-df-kib.asciidoc similarity index 93% rename from docs/ml/creating-df-kib.asciidoc rename to docs/user/ml/creating-df-kib.asciidoc index 872c9d5dda8b39..98fb772845a035 100644 --- a/docs/ml/creating-df-kib.asciidoc +++ b/docs/user/ml/creating-df-kib.asciidoc @@ -8,7 +8,7 @@ You can create {stack-ov}/ml-dataframes.html[{dataframe-transforms}] in the {kib} Machine Learning application. [role="screenshot"] -image::ml/images/ml-definepivot.jpg["Defining a {dataframe} pivot"] +image::user/ml/images/ml-definepivot.jpg["Defining a {dataframe} pivot"] Select the index pattern or saved search you want to transform. To pivot your data, you must group the data by at least one field and apply at least one @@ -22,7 +22,7 @@ for the target index. At the end of the process, a {dataframe} job is created as a result. [role="screenshot"] -image::ml/images/ml-jobid.jpg["Job ID and target index"] +image::user/ml/images/ml-jobid.jpg["Job ID and target index"] After you create {dataframe} jobs, you can start, stop, and delete them and explore their progress and statistics from the jobs list. diff --git a/docs/ml/creating-jobs.asciidoc b/docs/user/ml/creating-jobs.asciidoc similarity index 86% rename from docs/ml/creating-jobs.asciidoc rename to docs/user/ml/creating-jobs.asciidoc index 98f175041719a4..8eb1ab29897cc2 100644 --- a/docs/ml/creating-jobs.asciidoc +++ b/docs/user/ml/creating-jobs.asciidoc @@ -8,7 +8,7 @@ necessary to perform an analytics task. {kib} provides the following wizards to make it easier to create jobs: [role="screenshot"] -image::ml/images/ml-create-job.jpg[Create New Job] +image::user/ml/images/ml-create-job.jpg[Create New Job] A _single metric job_ is a simple job that contains a single _detector_. A detector defines the type of analysis that will occur and which fields to @@ -31,7 +31,7 @@ for that context. For example, if you appears: [role="screenshot"] -image::ml/images/ml-data-recognizer-sample.jpg[A screenshot of the {kib} sample data web log job creation wizard] +image::user/ml/images/ml-data-recognizer-sample.jpg[A screenshot of the {kib} sample data web log job creation wizard] TIP: Alternatively, after you load a sample data set on the {kib} home page, you can click *View data* > *ML jobs*. There are {anomaly-jobs} for both the sample eCommerce orders data set and the sample web logs data set. @@ -43,19 +43,19 @@ http://nginx.org/[Nginx] and https://httpd.apache.org/[Apache] HTTP servers to appear: [role="screenshot"] -image::ml/images/ml-data-recognizer-filebeat.jpg[A screenshot of the {filebeat} job creation wizards] +image::user/ml/images/ml-data-recognizer-filebeat.jpg[A screenshot of the {filebeat} job creation wizards] If you use {auditbeat-ref}/index.html[{auditbeat}] to audit process activity on your systems, the following wizards appear: [role="screenshot"] -image::ml/images/ml-data-recognizer-auditbeat.jpg[A screenshot of the {auditbeat} job creation wizards] +image::user/ml/images/ml-data-recognizer-auditbeat.jpg[A screenshot of the {auditbeat} job creation wizards] Likewise, if you use the {metricbeat-ref}/metricbeat-module-system.html[{metricbeat} system module] to monitor your servers, the following wizards appear: [role="screenshot"] -image::ml/images/ml-data-recognizer-metricbeat.jpg[A screenshot of the {metricbeat} job creation wizards] +image::user/ml/images/ml-data-recognizer-metricbeat.jpg[A screenshot of the {metricbeat} job creation wizards] These wizards create {anomaly-jobs}, dashboards, searches, and visualizations that are customized to help you analyze your {auditbeat}, {filebeat}, and diff --git a/docs/ml/images/ml-annotations-list.jpg b/docs/user/ml/images/ml-annotations-list.jpg similarity index 100% rename from docs/ml/images/ml-annotations-list.jpg rename to docs/user/ml/images/ml-annotations-list.jpg diff --git a/docs/ml/images/ml-create-job.jpg b/docs/user/ml/images/ml-create-job.jpg similarity index 100% rename from docs/ml/images/ml-create-job.jpg rename to docs/user/ml/images/ml-create-job.jpg diff --git a/docs/ml/images/ml-data-recognizer-auditbeat.jpg b/docs/user/ml/images/ml-data-recognizer-auditbeat.jpg similarity index 100% rename from docs/ml/images/ml-data-recognizer-auditbeat.jpg rename to docs/user/ml/images/ml-data-recognizer-auditbeat.jpg diff --git a/docs/ml/images/ml-data-recognizer-filebeat.jpg b/docs/user/ml/images/ml-data-recognizer-filebeat.jpg similarity index 100% rename from docs/ml/images/ml-data-recognizer-filebeat.jpg rename to docs/user/ml/images/ml-data-recognizer-filebeat.jpg diff --git a/docs/ml/images/ml-data-recognizer-metricbeat.jpg b/docs/user/ml/images/ml-data-recognizer-metricbeat.jpg similarity index 100% rename from docs/ml/images/ml-data-recognizer-metricbeat.jpg rename to docs/user/ml/images/ml-data-recognizer-metricbeat.jpg diff --git a/docs/ml/images/ml-data-recognizer-sample.jpg b/docs/user/ml/images/ml-data-recognizer-sample.jpg similarity index 100% rename from docs/ml/images/ml-data-recognizer-sample.jpg rename to docs/user/ml/images/ml-data-recognizer-sample.jpg diff --git a/docs/ml/images/ml-data-visualizer-sample.jpg b/docs/user/ml/images/ml-data-visualizer-sample.jpg similarity index 100% rename from docs/ml/images/ml-data-visualizer-sample.jpg rename to docs/user/ml/images/ml-data-visualizer-sample.jpg diff --git a/docs/ml/images/ml-definepivot.jpg b/docs/user/ml/images/ml-definepivot.jpg similarity index 100% rename from docs/ml/images/ml-definepivot.jpg rename to docs/user/ml/images/ml-definepivot.jpg diff --git a/docs/ml/images/ml-job-management.jpg b/docs/user/ml/images/ml-job-management.jpg similarity index 100% rename from docs/ml/images/ml-job-management.jpg rename to docs/user/ml/images/ml-job-management.jpg diff --git a/docs/ml/images/ml-jobid.jpg b/docs/user/ml/images/ml-jobid.jpg similarity index 100% rename from docs/ml/images/ml-jobid.jpg rename to docs/user/ml/images/ml-jobid.jpg diff --git a/docs/ml/images/ml-settings.jpg b/docs/user/ml/images/ml-settings.jpg similarity index 100% rename from docs/ml/images/ml-settings.jpg rename to docs/user/ml/images/ml-settings.jpg diff --git a/docs/ml/images/ml-single-metric-viewer.jpg b/docs/user/ml/images/ml-single-metric-viewer.jpg similarity index 100% rename from docs/ml/images/ml-single-metric-viewer.jpg rename to docs/user/ml/images/ml-single-metric-viewer.jpg diff --git a/docs/ml/index.asciidoc b/docs/user/ml/index.asciidoc similarity index 88% rename from docs/ml/index.asciidoc rename to docs/user/ml/index.asciidoc index eac51d06a51f9b..d3ca005d7b62ee 100644 --- a/docs/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -22,7 +22,7 @@ time field, you can use the *Data Visualizer* to identify possible fields for {anomaly-detect}: [role="screenshot"] -image::ml/images/ml-data-visualizer-sample.jpg[Data Visualizer for sample flight data] +image::user/ml/images/ml-data-visualizer-sample.jpg[Data Visualizer for sample flight data] experimental[] You can also upload a CSV, NDJSON, or log file (up to 100 MB in size). The *Data Visualizer* identifies the file format and field mappings. You @@ -33,20 +33,20 @@ If you have a trial or platinum license, you can Management* pane: [role="screenshot"] -image::ml/images/ml-job-management.jpg[Job Management] +image::user/ml/images/ml-job-management.jpg[Job Management] You can use the *Settings* pane to create and edit {stack-ov}/ml-calendars.html[calendars] and the filters that are used in {stack-ov}/ml-rules.html[custom rules]: [role="screenshot"] -image::ml/images/ml-settings.jpg[Calendar Management] +image::user/ml/images/ml-settings.jpg[Calendar Management] The *Anomaly Explorer* and *Single Metric Viewer* display the results of your {anomaly-jobs}. For example: [role="screenshot"] -image::ml/images/ml-single-metric-viewer.jpg[Single Metric Viewer] +image::user/ml/images/ml-single-metric-viewer.jpg[Single Metric Viewer] You can optionally add annotations by drag-selecting a period of time in the *Single Metric Viewer* and adding a description. For example, you can add an @@ -54,7 +54,7 @@ explanation for anomalies in that time period or provide notes about what is occurring in your operational environment at that time: [role="screenshot"] -image::ml/images/ml-annotations-list.jpg[Single Metric Viewer with annotations] +image::user/ml/images/ml-annotations-list.jpg[Single Metric Viewer with annotations] In some circumstances, annotations are also added automatically. For example, if the {anomaly-job} detects that there is missing data, it annotates the affected diff --git a/docs/ml/job-tips.asciidoc b/docs/user/ml/job-tips.asciidoc similarity index 100% rename from docs/ml/job-tips.asciidoc rename to docs/user/ml/job-tips.asciidoc