Skip to content

[ML] updating the infer trained model deployment docs #80083

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 2 commits into from
Oct 29, 2021

Conversation

benwtrent
Copy link
Member

the infer endpoint has changed its format.

Also, the results format for the various tasks have changed. This updates the docs to match what is currently in 8.0.0.

@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:ML Meta label for the ML team labels Oct 29, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

The input text for evaluation.
`docs`::
(Required, array)
An array of objects to pass to the model for inference. Currently, only a
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also explain that the doc has to contain a field called text_field on which inference is performed?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is only the case if the input is configured as text_field. This is fully configurable by the user on upload. I will mention that it has to be the same as your input fields and that it typically is text_field

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

Thanks for updating the docs, LGTM!

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

@benwtrent benwtrent merged commit 8887cfa into elastic:master Oct 29, 2021
@benwtrent benwtrent deleted the feature/ml-inference-api-docs branch October 29, 2021 17:07
benwtrent added a commit to benwtrent/elasticsearch that referenced this pull request Oct 29, 2021
the infer endpoint has changed its format.

Also, the results format for the various tasks have changed. This updates the docs to match what is currently in 8.0.0.
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.0

elasticsearchmachine pushed a commit that referenced this pull request Oct 29, 2021
the infer endpoint has changed its format.

Also, the results format for the various tasks have changed. This updates the docs to match what is currently in 8.0.0.
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 Team:Docs Meta label for docs team Team:ML Meta label for the ML team v8.0.0-beta1 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants