-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Move anomaly detection job resource definitions into APIs #49700
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
Conversation
Pinging @elastic/ml-core (:ml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like the CI build failed due to...
WARNING: ml/anomaly-detection/apis/put-job.asciidoc: line 36: tag 'job-id-def' not found in include file: /tmp/docsbuild/cyKWLdPar0/elasticsearch/docs/reference/rest-api/common-parms.asciidoc
a74af8b
to
6c988de
Compare
6c988de
to
9c997cf
Compare
@elasticmachine elasticseach-ci/docs-check |
@elasticmachine run elasticsearch-ci/docs-check |
Pinging @elastic/es-docs (>docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
I left a few comments and suggestions, nothing blocker though. Thank you for this enormous work!
include::{docdir}/ml/ml-shared.asciidoc[tag=influencers] | ||
|
||
`latency`::: | ||
(time units) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(time units) | |
(<<time-units,time units>>) |
docs/reference/ml/ml-shared.asciidoc
Outdated
tag::dependent_variable[] | ||
`dependent_variable`:: | ||
(Required, string) Defines which field of the document is to be predicted. | ||
Defines which field of the document is to be predicted. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we can put it back until I start to work on the DFA related parameters? I'd like to be consistent, too, but then we need to delete the name and the indicators between parentheses in the cases of dependent_variable, gamma, eta, lambda, feature_bag_fraction, maximum_number_trees, and so on, then open a PR that adds the removed info back to the API docs. Finally, merge and backport the two PRs (this one and the one that put the titles and indicators back to the API docs) in sync.
The other option is to leave it as-is for now and I'll remove the titles in this file and add them back in the API docs in one PR later. WDYT? If my train of thought is obscure and I explained my concern poorly, please let me know.
Defines which field of the document is to be predicted. | |
`dependent_variable`:: | |
(Required, string) Defines which field of the document is to be predicted. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, there was no reason for me to change this, since it isn't used by any of the APIs I updated.
Co-Authored-By: István Zoltán Szabó <[email protected]>
Co-Authored-By: István Zoltán Szabó <[email protected]>
Co-Authored-By: István Zoltán Szabó <[email protected]>
Co-Authored-By: István Zoltán Szabó <[email protected]>
Co-Authored-By: István Zoltán Szabó <[email protected]>
Co-Authored-By: István Zoltán Szabó <[email protected]>
Co-Authored-By: István Zoltán Szabó <[email protected]>
…stic#49700) Co-Authored-By: István Zoltán Szabó <[email protected]>
This PR adds tagged sections that contain descriptions of the anomaly detection job resource properties in https://github.com/elastic/elasticsearch/blob/master/docs/reference/ml/ml-shared.asciidoc. It removes the job resource definitions page (https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-job-resource.html) and uses the shared tagged sections to put that information directly into the appropriate APIs.
NOTE: As a result of these changes, users no longer need to flip between the job resource page and the API page to find all the necessary details. However, from a maintenance stand-point, it means that when parameters or properties are added or removed, each of the affected APIs' pages must be updated appropriately.
Subsequent PRs will be opened to (1) add missing indicators of which properties are required or optional in the create job API, (2) minimize some of the overly long property descriptions, and (3) merge some of the varied definitions for "job_id", since it seems unlikely so many variations are needed.
Preview:
http://elasticsearch_49700.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/ml-put-job.html
http://elasticsearch_49700.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/ml-get-job.html
http://elasticsearch_49700.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/ml-update-job.html
...