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] Updates infer trained model API docs with inference_config #88500

Merged
merged 5 commits into from
Jul 13, 2022

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Jul 13, 2022

Overview

This PR updates the infer trained model API docs by adding the inference_config property to the request body parameters. The parameter descriptions are single-sourced from the ml/ml-shared.asciidoc file.

It also adds the missing results_field to the inference_config property in the PUT API docs.

Preview

@szabosteve szabosteve added >docs General docs changes :ml Machine learning Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v8.4.0 v8.3.3 labels Jul 13, 2022
@szabosteve szabosteve marked this pull request as ready for review July 13, 2022 11:23
@elasticmachine elasticmachine added the Team:ML Meta label for the ML team label Jul 13, 2022
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

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

@szabosteve szabosteve requested a review from benwtrent July 13, 2022 11:23
Copy link
Member

@benwtrent benwtrent left a comment

Choose a reason for hiding this comment

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

All the nlp inference configs also support a results_field parameter like classification and regression

@szabosteve
Copy link
Contributor Author

@benwtrent Thanks for your review. I applied your suggestions and added results_field to the task configs. If I understand it correctly, the results_field should be present in the inference_config in PUT, too, shouldn't it?

@szabosteve szabosteve requested a review from benwtrent July 13, 2022 12:26
@szabosteve szabosteve merged commit cf68d0f into elastic:master Jul 13, 2022
szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Jul 13, 2022
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.3

szabosteve added a commit that referenced this pull request Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v8.3.3 v8.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants