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] Adds data frame analytics APIs to the ML APIs #43875

Merged
merged 13 commits into from
Jul 5, 2019
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/delete-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
++++

beta[]
experimental[]

Deletes an existing {dfanalytics-job}.

Expand Down
9 changes: 7 additions & 2 deletions docs/reference/ml/apis/evaluate-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,15 @@
<titleabbrev>Evaluate {dfanalytics}</titleabbrev>
++++

beta[]
experimental[]

Evaluates the executed analysis on an index that is already annotated with a
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
field that marks each {dataframe} row with the results of the analytics.
field that contains the results of the analytics (the `ground truth`) for each
{dataframe} row. Evaluation is typically done via calculating a set of metrics
that capture various aspects of the quality of the results over the data for
which we have the `ground truth`. For different types of analyses different
metrics are suitable. This API packages together commonly used metrics for
various analyses.

[[ml-evaluate-dataframe-request]]
==== {api-request-title}
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/ml/apis/get-dfanalytics-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev>
++++

beta[]
experimental[]

Retrieves usage information for {dfanalytics-jobs}.

Expand Down Expand Up @@ -38,6 +38,10 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
these options, the API returns information for the first hundred
{dfanalytics-jobs}.

`allow_no_match` (Optional)
(boolean) If `false` and the `data_frame_analytics_id` does not match any
{dfanalytics-job} an error will be returned. The default value is `true`.

[[ml-get-dfanalytics-stats-query-params]]
==== {api-query-parms-title}
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/ml/apis/get-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<titleabbrev>Get {dfanalytics-jobs}</titleabbrev>
++++

beta[]
experimental[]

Retrieves configuration information for {dfanalytics-jobs}.

Expand Down Expand Up @@ -45,6 +45,10 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
these options, the API returns information for the first hundred
{dfanalytics-jobs}.

`allow_no_match` (Optional)
(boolean) If `false` and the `data_frame_analytics_id` does not match any
{dfanalytics-job} an error will be returned. The default value is `true`.

[[ml-get-dfanalytics-query-params]]
==== {api-query-parms-title}
Expand Down
15 changes: 13 additions & 2 deletions docs/reference/ml/apis/put-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<titleabbrev>Create {dfanalytics-jobs}</titleabbrev>
++++

beta[]
experimental[]

Instantiates a {dfanalytics-job}.

Expand Down Expand Up @@ -43,7 +43,18 @@ and {stack-ov}/built-in-roles.html[Built-in roles].

`dest` (Required)::
(object) The destination configuration, consisting of `index` and optionally
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
`results_field` (`ml` by default).
`results_field` (`ml` by default). The destination index will be automatically
created if it does not exist. The `index.number_of_shards` and
`index.number_of_replicas` settings of the source index will be copied over the
destination index. When the source index matches multiple indices, these
settings will be set to the maximum values found in the source indices.

The mappings of the source indicies are also attempted to being copied over
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
`dest`, however, if the mappings of any of the fields don't match among the
source indicies, the attempt will fail with an error message.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved

If `dest` already exists, then it will be use as is. This makes it possible to
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
set up the destination index in advance with custom settings and mappings.

`analysis` (Required)::
(object) Defines the type of {dfanalytics} you want to perform on your source
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/ml/apis/start-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
<titleabbrev>Start {dfanalytics-jobs}</titleabbrev>
++++

beta[]
experimental[]

Starts one or more {dfanalytics-jobs}.
Starts a {dfanalytics-job}.

[[ml-start-dfanalytics-request]]
==== {api-request-title}
Expand All @@ -33,6 +33,10 @@ and {stack-ov}/built-in-roles.html[Built-in roles].
(string) Identifier for the {dfanalytics-job}. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.

`timeout` (Optional)::
(time) Controls the amount of time to wait until the {dfanalytics-job} starts.
The default value is 20 seconds.

dimitris-athanasiou marked this conversation as resolved.
Show resolved Hide resolved
[[ml-start-dfanalytics-example]]
==== {api-examples-title}
Expand Down
24 changes: 23 additions & 1 deletion docs/reference/ml/apis/stop-dfanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<titleabbrev>Stop {dfanalytics-jobs}</titleabbrev>
++++

beta[]
experimental[]

Stops one or more {dfanalytics-jobs}.

Expand All @@ -28,13 +28,35 @@ Stops one or more {dfanalytics-jobs}.
information, see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].

[[ml-stop-dfanalytics-desc]]
==== {api-description-title}

A {dfanalytics-job} can be started and stopped multiple times throughout its
lifecycle.

You can stop multiple {dfanalytics-jobs} in a single API request by using a
comma-separated list of {dfanalytics-jobs} or a wildcard expression. You can
stop all {dfanalytics-job} by using _all or by specifying * as the
<data_frame_analytics_id>.

[[ml-stop-dfanalytics-path-params]]
==== {api-path-parms-title}

`<data_frame_analytics_id>` (Required)::
(string) Identifier for the {dfanalytics-job}. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.

`timeout` (Optional)::
Controls the amount of time to wait until the {dfanalytics-job} stops.
The default value is 20 seconds.

`force` (Optional)::
(boolean) If true, the {dfanalytics-job} is stopped forcefully.

`allow_no_match` (Optional)
(boolean) If `false` and the `data_frame_analytics_id` does not match any
{dfanalytics-job} an error will be returned. The default value is `true`.

szabosteve marked this conversation as resolved.
Show resolved Hide resolved
[[ml-stop-dfanalytics-example]]
==== {api-examples-title}
Expand Down