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 feature importance mapping subsection to inference processor docs #54190

Merged
merged 7 commits into from
Mar 26, 2020

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Mar 25, 2020

This PR adds preferred field mapping and field path to feature importance in the inference processor documentation.

Preview: http://elasticsearch_54190.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/inference-processor.html

Depends on elastic/docs#1784

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@szabosteve szabosteve added the :ml Machine learning label Mar 25, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (:ml)


[source,js]
--------------------------------------------------
{
Copy link
Member

Choose a reason for hiding this comment

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

This should indicate that this is the mapping for the feature importance result field.

`ml.<inference.target_field>`.`<inference.tag>`.`feature_importance`

If `inference.tag` is not provided in the processor definition, it is not part
of the field path. The `<inference.target_field>` defaults to `inference`.
Copy link
Member

Choose a reason for hiding this comment

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

probably some inference configs + field name examples?

{
    "tag": "foo",
    ...
}

Writes feature importance to field ml.inference.foo.feature_importance.

{
    "tag": "foo",
    "target_field": "my_field"
}

Writes feature importance to field my_field.foo.feature_importance.


In this case, `{feat-imp}` is exposed in the
`ml.my_field.foo.feature_importance` field.
Copy link
Member

Choose a reason for hiding this comment

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

it is not ml.my_field. Its just my_field.foo.feature_importance

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@benwtrent Thanks. I also updated the schema accordingly. I.e.: <ml.inference.target_field>.<inference.tag>.feature_importance instead of
ml.<inference.target_field>.<inference.tag>.feature_importance

@szabosteve szabosteve merged commit a65e95e into elastic:master Mar 26, 2020
@szabosteve szabosteve deleted the inference.mapping branch March 26, 2020 08:22
szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Mar 26, 2020
szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Mar 26, 2020
@szabosteve
Copy link
Contributor Author

Backport commits:
7.x: 487b273
7.7: 5543b81

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.1 v7.8.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants