Skip to content

[DOCS] Changes experimental flag to beta in DFA related docs #63992

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

Merged
merged 15 commits into from
Oct 26, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Delete {dfanalytics-jobs} API

experimental::[]
beta::[]

Delete an existing {dfanalytics-job}.
The API accepts a +{request}+ object as a request and returns a +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Delete trained models API

experimental::[]
beta::[]

Deletes a previously saved trained model.
The API accepts a +{request}+ object and returns a +{response}+.
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/ml/evaluate-data-frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Evaluate {dfanalytics} API

experimental::[]
beta::[]

Evaluates the {dfanalytics} for an annotated index.
The API accepts an +{request}+ object and returns an +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Explain {dfanalytics} API

experimental::[]
beta::[]

Explains the following about a {dataframe-analytics-config}:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Get {dfanalytics-jobs} stats API

experimental::[]
beta::[]

Retrieves the operational statistics of one or more {dfanalytics-jobs}.
The API accepts a +{request}+ object and returns a +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Get {dfanalytics-jobs} API

experimental::[]
beta::[]

Retrieves one or more {dfanalytics-jobs}.
The API accepts a +{request}+ object and returns a +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Get trained models stats API

experimental::[]
beta::[]

Retrieves one or more trained model statistics.
The API accepts a +{request}+ object and returns a +{response}+.
Expand Down
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/ml/get-trained-models.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Get trained models API

experimental::[]
beta::[]

Retrieves one or more trained models.
The API accepts a +{request}+ object and returns a +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Put {dfanalytics-jobs} API

experimental::[]
beta::[]

Creates a new {dfanalytics-job}.
The API accepts a +{request}+ object as a request and returns a +{response}+.
Expand Down
4 changes: 1 addition & 3 deletions docs/java-rest/high-level/ml/put-trained-model.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
[id="{upid}-{api}"]
=== Put trained models API

experimental:[]

experimental::[]
beta::[]

Creates a new trained model for inference.
The API accepts a +{request}+ object as a request and returns a +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Start {dfanalytics-jobs} API

experimental::[]
beta::[]

Starts an existing {dfanalytics-job}.
It accepts a +{request}+ object and responds with a +{response}+ object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Stop {dfanalytics-jobs} API

experimental::[]
beta::[]

Stops a running {dfanalytics-job}.
It accepts a +{request}+ object and responds with a +{response}+ object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="{upid}-{api}"]
=== Update {dfanalytics-jobs} API

experimental::[]
beta::[]

Updates an existing {dfanalytics-job}.
The API accepts an +{request}+ object as a request and returns an +{response}+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[[search-aggregations-pipeline-inference-bucket-aggregation]]
=== {infer-cap} Bucket Aggregation

experimental::[]
beta::[]

A parent pipeline aggregation which loads a pre-trained model and performs
{infer} on the collated result fields from the parent bucket aggregation.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ingest/processors/inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<titleabbrev>{infer-cap}</titleabbrev>
++++

experimental::[]
beta::[]

Uses a pre-trained {dfanalytics} model to infer against the data that is being
ingested in the pipeline.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Deletes an existing {dfanalytics-job}.

experimental[]
beta[]


[[ml-delete-dfanalytics-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Deletes an existing trained {infer} model that is currently not referenced by an
ingest pipeline.

experimental[]
beta[]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are some tags beta::[] but others beta[]?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the latter was the pre-Asciidoctor format. Since https://github.com/elastic/docs#using-the-beta-admonition recommends the former, I'll make them all the same.



[[ml-delete-trained-models-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Evaluates the {dfanalytics} for an annotated index.

experimental[]
beta[]


[[ml-evaluate-dfanalytics-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Explains a {dataframe-analytics-config}.

experimental[]
beta[]


[[ml-explain-dfanalytics-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Retrieves usage information for {dfanalytics-jobs}.

experimental[]
beta[]

[[ml-get-dfanalytics-stats-request]]
== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Retrieves configuration information for {dfanalytics-jobs}.

experimental[]
beta[]


[[ml-get-dfanalytics-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Retrieves usage information for trained models.

experimental[]
beta[]


[[ml-get-trained-models-stats-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Retrieves configuration information for a trained model.

experimental[]
beta[]


[[ml-get-trained-models-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Instantiates a {dfanalytics-job}.

experimental[]
beta[]

[[ml-put-dfanalytics-request]]
== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ WARNING: Models created in version 7.8.0 are not backwards compatible
a 7.8.0 node.


experimental[]
beta[]


[[ml-put-trained-models-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Starts a {dfanalytics-job}.

experimental[]
beta[]

[[ml-start-dfanalytics-request]]
== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Stops one or more {dfanalytics-jobs}.

experimental[]
beta[]

[[ml-stop-dfanalytics-request]]
== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Updates an existing {dfanalytics-job}.

experimental[]
beta[]

[[ml-update-dfanalytics-request]]
== {api-request-title}
Expand Down