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] Clarifies description of num_top_feature_importance_values #52246

Merged
merged 5 commits into from
Feb 18, 2020

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Feb 12, 2020

This PR clarifies the descriptions for analysis.classification.num_top_feature_importance_values and analysis.regression.num_top_feature_importance_values in the create data frame analytics job API.

Preview: http://elasticsearch_52246.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/put-dfanalytics.html

@lcawl lcawl added >docs General docs changes :ml Machine learning v8.0.0 v7.7.0 v7.6.1 labels Feb 12, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (:ml)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@lcawl lcawl marked this pull request as ready for review February 13, 2020 18:47
Copy link
Contributor

@valeriy42 valeriy42 left a comment

Choose a reason for hiding this comment

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

I noticed that you removed the reference to the SHAP algorithm. I think it should be described somewhere in the documentation.

Furthermore, we should say that we may return less feature importance values than the parameter specifies if there are no more features available in the model or if the feature importance of other features for this document is zero.

lcawl and others added 2 commits February 14, 2020 08:39
Co-Authored-By: Valeriy Khakhutskyy <1292899+valeriy42@users.noreply.github.com>
Co-Authored-By: Valeriy Khakhutskyy <1292899+valeriy42@users.noreply.github.com>
@lcawl
Copy link
Contributor Author

lcawl commented Feb 14, 2020

I noticed that you removed the reference to the SHAP algorithm. I think it should be described somewhere in the documentation.

It still exists in the pages that are linked from these API property descriptions (e.g. http://elasticsearch_52246.docs-preview.app.elstc.co/guide/en/machine-learning/master/dfa-classification.html#dfa-classification-feature-importance).

@lcawl
Copy link
Contributor Author

lcawl commented Feb 14, 2020

Furthermore, we should say that we may return less feature importance values than the parameter specifies if there are no more features available in the model or if the feature importance of other features for this document is zero.

IMO That seems like the type of information that will require further explanation and should be added in the https://www.elastic.co/guide/en/machine-learning/current/dfa-regression.html#dfa-regression-feature-importance and https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html#dfa-classification-feature-importance pages. I've created elastic/stack-docs#881

@lcawl lcawl merged commit f41ebe4 into elastic:master Feb 18, 2020
@lcawl lcawl deleted the num-top-features branch February 18, 2020 16:48
lcawl added a commit that referenced this pull request Feb 18, 2020
…2246)

Co-Authored-By: Valeriy Khakhutskyy <1292899+valeriy42@users.noreply.github.com>
lcawl added a commit that referenced this pull request Feb 18, 2020
…2246)

Co-Authored-By: Valeriy Khakhutskyy <1292899+valeriy42@users.noreply.github.com>
sbourke pushed a commit to sbourke/elasticsearch that referenced this pull request Feb 19, 2020
…astic#52246)

Co-Authored-By: Valeriy Khakhutskyy <1292899+valeriy42@users.noreply.github.com>
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.6.1 v7.7.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants