Skip to content

[DOCS] Edits create data frame analytics job API#54751

Merged
lcawl merged 4 commits intoelastic:masterfrom
lcawl:multiclass-API
Apr 13, 2020
Merged

[DOCS] Edits create data frame analytics job API#54751
lcawl merged 4 commits intoelastic:masterfrom
lcawl:multiclass-API

Conversation

@lcawl
Copy link
Copy Markdown
Member

@lcawl lcawl commented Apr 3, 2020

This PR updates the create data frame analytics job API (https://www.elastic.co/guide/en/elasticsearch/reference/master/put-dfanalytics.html) related to the addition of multiclass classification. For example, it updates the dependent_variable and num_top_classes definitions.

It also edits some existing unrelated content. For example, it comments out hyperparameter optimization details that are moving in elastic/stack-docs#990 and it moves details about mappings from the create DFA job API to the start DFA job API.

Preview:

@lcawl lcawl added >docs General docs changes WIP :ml Machine learning v8.0.0 v7.7.0 v7.8.0 labels Apr 3, 2020
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/ml-core (:ml)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We copy the mappings to the dest index when the _start API is called. Indeed, if the mappings are conflicted, the start API fails with an error. But during job creation we don't check.

_hyperparameter optimization_ occurs. It determines a value for each of the
undefined parameters. A fixed number of rounds is used for optimization which
depends on the number of parameters being optimized.
// TBD: Does this "fixed number of rounds" sentence mean that the more undefined
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@tveasey Could you help us clarify this please?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I will pursue this in elastic/stack-docs#990 instead

Copy link
Copy Markdown
Contributor

@dimitris-athanasiou dimitris-athanasiou left a comment

Choose a reason for hiding this comment

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

LGTM

@dimitris-athanasiou
Copy link
Copy Markdown
Contributor

I LGTM'd too soon, didn't notice the WIP label

@lcawl lcawl removed the WIP label Apr 10, 2020
@lcawl lcawl marked this pull request as ready for review April 10, 2020 00:55
Copy link
Copy Markdown
Contributor

@dimitris-athanasiou dimitris-athanasiou left a comment

Choose a reason for hiding this comment

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

Looks good! Just a small typo.

+
The data type of the field must be numeric (`integer`, `short`, `long`, `byte`),
categorical (`ip` or `keyword`), or boolean.
categorical (`ip` or `keyword`), or boolean. There must be be no more than 30
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

typo: double be

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good catch, thanks!

@lcawl lcawl merged commit 998a085 into elastic:master Apr 13, 2020
@lcawl lcawl deleted the multiclass-API branch April 13, 2020 16:58
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Apr 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :ml Machine learning v7.7.0 v7.8.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants